Project

Profile

Help

Task #4104

closed

Add index and headings to REST API docs

Added by dkliban@redhat.com about 6 years ago. Updated almost 5 years ago.

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

0%

Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 51
Quarter:

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

Related to Pulp - Test #4123: Test the generated API bindsCLOSED - COMPLETEdkliban@redhat.comActions
Actions #1

Updated by daviddavis about 6 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes
Actions #2

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.

Actions #3

Updated by dkliban@redhat.com about 6 years ago

  • Sprint set to Sprint 45
Actions #4

Updated by rchan almost 6 years ago

  • Sprint changed from Sprint 45 to Sprint 46
Actions #5

Updated by rchan almost 6 years ago

  • Sprint changed from Sprint 46 to Sprint 47
Actions #6

Updated by rchan almost 6 years ago

  • Sprint changed from Sprint 47 to Sprint 48
Actions #7

Updated by rchan almost 6 years ago

  • Sprint changed from Sprint 48 to Sprint 49
Actions #9

Updated by rchan over 5 years ago

  • Sprint changed from Sprint 49 to Sprint 50
Actions #10

Updated by rchan over 5 years ago

  • Sprint changed from Sprint 50 to Sprint 51
Actions #11

Updated by dkliban@redhat.com over 5 years ago

  • Status changed from NEW to ASSIGNED

Added by dkliban@redhat.com over 5 years ago

Revision f5a1d28c | View on GitHub

Problem: OpenAPI schema test is unreliable between different installs

Solution: Remove the test

re: #4104 https://pulp.plan.io/issues/4104

Actions #13

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.

re: #4104 https://pulp.plan.io/issues/4104

Actions #14

Updated by dkliban@redhat.com over 5 years ago

  • Status changed from POST to MODIFIED
Actions #15

Updated by ipanova@redhat.com over 5 years ago

  • Assignee set to dkliban@redhat.com
Actions #16

Updated by daviddavis over 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions #17

Updated by bmbouter over 5 years ago

  • Tags deleted (Pulp 3)
Actions #18

Updated by bmbouter almost 5 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF