Story #8468
Updated by ttereshc over 2 years ago
Our current docs provide an example of API calls to upload an advisory but nowhere a user can see the appropriate format and meaning of each field.
API docs show only the highest level of advisory metadata and no pkglist or references.
Ideally, the whole advisory format should be visible in the API docs, and detailed descriptions of fields can be in the static docs.
Currently, there are only some hints in the code.
advisory metadata (everything without pkglist and references)
https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models/advisory.py#L39-L71
Pkglist Collection
https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models/advisory.py#L242-L247
Package in a collection
https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models/advisory.py#L339-L362
References
https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models/advisory.py#L488-L495
Advisory (Erratum):
- metadata
- pkglist
- references
Pkglist is a list of collections.
Collection is a list of packages.
.