Story #8468

Updated by ttereshc almost 3 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) 
 Pkglist Collection 
 Package in a collection 

 Advisory (Erratum): 
  - metadata 
  - pkglist 
  - references 
 Pkglist is a list of collections.   
 Collection is a list of packages.