Actions
Task #3302
closed
Add DRF OpenAPI body parameters description
Start date:
Due date:
% Done:
0%
Estimated time:
Platform Release:
3.0.0
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:
Description
When creating a distribution one of the required body parameters is the publisher, as per DRF OpenAPI documentation.
/api/v3/distributions/
publisher string Required
Publications created by this publisher are automaticallyserved as defined by this distribution
This parameter can not be any string, it has to be _href of the publisher, adding this to the description will improve the documentation. This is just one example, there are other similar cases.
Updated by amacdona@redhat.com almost 6 years ago
- Subject changed from DRP OpenAPI body parameters description to Add DRF OpenAPI body parameters description
Updated by dkliban@redhat.com over 5 years ago
I think this task can be closed now: https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/distributions_create
Updated by amacdona@redhat.com over 5 years ago
- Status changed from NEW to CLOSED - CURRENTRELEASE
Closing now. As @dkliban mentioned, this is much better covered by the published swagger docs. Specifically, the publisher is not required, and the types are better represented for the fields.
string <uri> (Publisher) Nullable
Actions
.