Project

Profile

Help

Story #4636

As a user, I can view helpful REST API docs

Added by amacdona@redhat.com 7 months ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 51

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/

History

#1 Updated by dkliban@redhat.com 7 months ago

  • Status changed from NEW to MODIFIED
  • Assignee set to dkliban@redhat.com

#2 Updated by dkliban@redhat.com 7 months ago

  • Sprint set to Sprint 51

#3 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#4 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF