Task #4104
closedAdd index and headings to REST API docs
0%
Description
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.
Related issues
Updated by daviddavis about 6 years ago
- Groomed changed from No to Yes
- Sprint Candidate changed from No to Yes
Updated by amacdona@redhat.com about 6 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.
Updated by ttereshc almost 6 years 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
Updated by dkliban@redhat.com over 5 years ago
- Status changed from NEW to ASSIGNED
Updated by dkliban@redhat.com over 5 years ago
- Status changed from ASSIGNED to POST
Added by dkliban@redhat.com over 5 years ago
Updated by kersom over 5 years ago
- Related to Test #4123: Test the generated API binds added
Added by dkliban@redhat.com over 5 years ago
Revision e817af65 | View on GitHub
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.
Updated by dkliban@redhat.com over 5 years ago
- Status changed from POST to MODIFIED
Updated by ipanova@redhat.com over 5 years ago
- Assignee set to dkliban@redhat.com
Updated by bmbouter about 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Problem: OpenAPI schema test is unreliable between different installs
Solution: Remove the test
re: #4104 https://pulp.plan.io/issues/4104