Add index and headings to REST API docs
The REST API docs for pulpcore are very long and hard to navigate. The page could use an index and some headings to seperate the docs into sections.
Problem: REST API docs are poorly organized
Solution: Break up REST API docs into sections
This patch modifies the OpenAPI schema. It introduces the concept of Tags. Each tag represents a type of resource in Pulp. E.g. Artifacts, Content, Remotes, Publishers, etc.
This patch also improves the 'summary' field for each operation also. This is achieved with a new custom inspector class that drf_yasg can use to build the OpenAPI schema.
This patch also adds a new 'restapi.html' page to the static docs. This new page uses ReDoc and the OpenAPI schema to display the REST API docs.
#2 Updated by email@example.com about 2 years ago
Can we also s/REST API Integration/Web API/ since we will be making an index.
Since the API is not just for integrators, but for users I think this makes more sense. Also, just to be a stickler, we are pretty RESTful, but I prefer to avoid the term if we aren't fully compliant. If this is controversial, ignore it, no reason to slow the main purpose of this.
#8 Updated by ttereshc over 1 year ago
These are the docs which require refactor https://docs.pulpproject.org/en/3.0/nightly/integration-guide/rest-api/index.html#rest-api-reference
Please register to edit this issue