Actions
Story #4636
closed
As a user, I can view helpful REST API docs
Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:
0%
Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 51
Quarter:
Description
Our current REST documentation published in our docs is inadequate, even useless. It leaves out too much information that is included in the schema doc, and is not very helpful to users.
Our live-api documentation can be hosted on any running pulp instance. These docs are much more useful.
This story is improve the published REST API docs, and we have a handful of options.
Good summary of the problem and 6 options: https://idratherbewriting.com/learnapidoc/pubapis_combine_swagger_and_guide.html
Option 7: https://sphinxcontrib-redoc.readthedocs.io/en/stable/
Actions
.