Project

Profile

Help

Issue #3621

closed

/repositories/ api docs includes no parameter documentation

Added by jsherril@redhat.com over 4 years ago. Updated over 3 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:

Description

Actions #1

Updated by dalley over 4 years ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 36
Actions #2

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 36 to Sprint 37
Actions #3

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 37 to Sprint 38
Actions #4

Updated by rchan over 4 years ago

  • Sprint changed from Sprint 38 to Sprint 39
Actions #5

Updated by daviddavis over 4 years ago

  • Tags Documentation added
Actions #6

Updated by jortel@redhat.com over 4 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to jortel@redhat.com
Actions #7

Updated by jortel@redhat.com over 4 years ago

The schema includes field descriptions. This is a known deficiency in the openapi plugin: https://github.com/ikalnytskyi/sphinxcontrib-openapi/issues/14

Actions #8

Updated by jortel@redhat.com over 4 years ago

  • Status changed from ASSIGNED to NEW
  • Assignee deleted (jortel@redhat.com)
Actions #9

Updated by jortel@redhat.com over 4 years ago

wrote:

The schema includes field descriptions. This is a known deficiency in the openapi plugin: https://github.com/ikalnytskyi/sphinxcontrib-openapi/issues/14 and needs to be fixed in a PR to that project.

Actions #10

Updated by dkliban@redhat.com over 4 years ago

  • Sprint changed from Sprint 39 to Sprint 40
Actions #11

Updated by rchan over 4 years ago

  • Sprint deleted (Sprint 40)
Actions #12

Updated by dkliban@redhat.com about 4 years ago

This is a limitation of the library we are using the generate the docs. He is looking for contributions.

https://github.com/ikalnytskyi/sphinxcontrib-openapi/issues/14

Actions #13

Updated by amacdona@redhat.com over 3 years ago

  • Status changed from NEW to CLOSED - CURRENTRELEASE

Publishing the swagger docs onto rtd seems to have taken care of this problem:
https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_create

Please reopen if there is more that needs to be done.

Actions #14

Updated by daviddavis over 3 years ago

  • Sprint/Milestone set to 3.0.0
Actions #15

Updated by bmbouter over 3 years ago

  • Tags deleted (Pulp 3)

Also available in: Atom PDF