Project

Profile

Help

Story #4637

closed

As a plugin writer, I know how to publish REST API docs

Added by amacdona@redhat.com about 3 years ago. Updated over 1 year ago.

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:
Quarter:

Description

https://pulp.plan.io/issues/4636 is how pulpcore will publish REST API docs. This strategy will work best if plugins do this as well, because many of the user-facing REST calls are plugin-specific.

This story is to share the process for publishing pulpcore's REST API in pulpcore-plugin's Plugin Writer's guide.

Actions #1

Updated by ipanova@redhat.com about 3 years ago

+1 i see the benefit in having this documented

Actions #2

Updated by amacdona@redhat.com about 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #3

Updated by amacdona@redhat.com about 3 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to amacdona@redhat.com
  • Sprint set to Sprint 52
Actions #4

Updated by bmbouter about 3 years ago

  • Tags deleted (Pulp 3)
Actions #5

Updated by rchan about 3 years ago

  • Sprint changed from Sprint 52 to Sprint 53
Actions #6

Updated by amacdona@redhat.com almost 3 years ago

  • Sprint changed from Sprint 53 to Sprint 54
Actions #7

Updated by ttereshc almost 3 years ago

  • Sprint changed from Sprint 54 to Sprint 55
Actions #8

Updated by dkliban@redhat.com almost 3 years ago

  • Sprint changed from Sprint 55 to Sprint 56
Actions #9

Updated by rchan almost 3 years ago

  • Sprint changed from Sprint 56 to Sprint 57
Actions #10

Updated by rchan over 2 years ago

  • Sprint changed from Sprint 57 to Sprint 58
Actions #11

Updated by rchan over 2 years ago

  • Sprint changed from Sprint 58 to Sprint 59
Actions #12

Updated by daviddavis over 2 years ago

  • Sprint/Milestone deleted (3.0.0)
Actions #13

Updated by amacdona@redhat.com over 2 years ago

  • Status changed from ASSIGNED to NEW
  • Assignee deleted (amacdona@redhat.com)
  • Sprint deleted (Sprint 59)
Actions #14

Updated by dkliban@redhat.com over 1 year ago

  • Status changed from NEW to CLOSED - CURRENTRELEASE

Plugin template provides a way to publish REST API docs.

Also available in: Atom PDF