Project

Profile

Help

Story #4637

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

Added by amacdona@redhat.com 8 months ago. Updated 3 months ago.

Status:
NEW
Priority:
Normal
Assignee:
-
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:

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.

History

#1 Updated by ipanova@redhat.com 8 months ago

+1 i see the benefit in having this documented

#2 Updated by amacdona@redhat.com 8 months ago

  • Sprint/Milestone set to 3.0

#3 Updated by amacdona@redhat.com 8 months ago

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

#4 Updated by bmbouter 8 months ago

  • Tags deleted (Pulp 3)

#5 Updated by rchan 7 months ago

  • Sprint changed from Sprint 52 to Sprint 53

#6 Updated by amacdona@redhat.com 6 months ago

  • Sprint changed from Sprint 53 to Sprint 54

#7 Updated by ttereshc 6 months ago

  • Sprint changed from Sprint 54 to Sprint 55

#8 Updated by dkliban@redhat.com 5 months ago

  • Sprint changed from Sprint 55 to Sprint 56

#9 Updated by rchan 4 months ago

  • Sprint changed from Sprint 56 to Sprint 57

#10 Updated by rchan 4 months ago

  • Sprint changed from Sprint 57 to Sprint 58

#11 Updated by rchan 3 months ago

  • Sprint changed from Sprint 58 to Sprint 59

#12 Updated by daviddavis 3 months ago

  • Sprint/Milestone deleted (3.0)

#13 Updated by amacdona@redhat.com 3 months ago

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

Please register to edit this issue

Also available in: Atom PDF