Project

Profile

Help

Story #8468

closed

As a user, I can learn from the docs about meaning of each field and the format of advisory to be able to create one

Added by ttereshc almost 2 years ago. Updated about 1 year ago.

Status:
CLOSED - DUPLICATE
Priority:
Normal
Assignee:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

Description

Ticket moved to GitHub: "pulp/pulp_rpm/2269":https://github.com/pulp/pulp_rpm/issues/2269


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.

Also available in: Atom PDF