Project

Profile

Help

Actions
Send by e-mail Copy link

Story #4636

closed

As a user, I can view helpful REST API docs

Added by amacdona@redhat.com over 5 years ago. Updated about 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
dkliban@redhat.com
Category:
-
Sprint/Milestone:
3.0.0
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
Copy link
 #1

Updated by dkliban@redhat.com over 5 years ago

  • Status changed from NEW to MODIFIED
  • Assignee set to dkliban@redhat.com
Actions
Copy link
 #2

Updated by dkliban@redhat.com over 5 years ago

  • Sprint set to Sprint 51
Actions
Copy link
 #3

Updated by daviddavis over 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions
Copy link
 #4

Updated by bmbouter over 5 years ago

  • Tags deleted (Pulp 3)
Actions
Copy link
 #5

Updated by bmbouter about 5 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Actions
Send by e-mail Copy link

Also available in: Atom PDF