Project

Profile

Help

Send by e-mail

Issue #3621

/repositories/ api docs includes no parameter documentation

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

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
3.0.0
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

https://docs.pulpproject.org/en/3.0/nightly/integration-guide/rest-api/index.html#post--repositories-

tells nothing about what parameters are accepted for PUT/POST

History

#1 Updated by dalley over 3 years ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 36

#2 Updated by rchan over 3 years ago

  • Sprint changed from Sprint 36 to Sprint 37

#3 Updated by rchan over 3 years ago

  • Sprint changed from Sprint 37 to Sprint 38

#4 Updated by rchan over 3 years ago

  • Sprint changed from Sprint 38 to Sprint 39

#5 Updated by daviddavis over 3 years ago

  • Tags Documentation added

#6 Updated by jortel@redhat.com over 3 years ago

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

#7 Updated by jortel@redhat.com over 3 years ago

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

#8 Updated by jortel@redhat.com over 3 years ago

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

#9 Updated by jortel@redhat.com over 3 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.

#10 Updated by dkliban@redhat.com over 3 years ago

  • Sprint changed from Sprint 39 to Sprint 40

#11 Updated by rchan over 3 years ago

  • Sprint deleted (Sprint 40)

#12 Updated by dkliban@redhat.com about 3 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

#13 Updated by amacdona@redhat.com over 2 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.

#14 Updated by daviddavis over 2 years ago

  • Sprint/Milestone set to 3.0.0

#15 Updated by bmbouter over 2 years ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Send by e-mail

Also available in: Atom PDF