[Pulp-dev] proposed changes to Pulp 3 auto generated docs

Dennis Kliban dkliban at redhat.com
Wed Jul 18 13:31:42 UTC 2018

I am working on improving the OpenAPI 2.0 schema for Pulp 3. I would like
to get some input on the improvements I am proposing. The schema is used to
generate our REST API documentation as well as the bindings with

The docs generated from our current schema look something like this:

GET /repositories/{repository_pk}/versions/{number}/content/

   - *number* (*integer*) –
   - *repository_pk* (*string*) –

Status Codes:

   - 200 OK
   <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1> –

Since Pulp identifies resources using their HREFs, I am proposing that the
schema produce documentation that states:

GET /{repository_version_href}/content/

   - *repository_version_href* (string) – HREF for the repository version

Status Codes:

   - 200 OK
   <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1> –

Thoughts? Ideas? All feedback is welcome. Thank you!
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20180718/c6bcd68d/attachment.htm>

More information about the Pulp-dev mailing list