Project

Profile

Help

Task #3302

Add DRF OpenAPI body parameters description

Added by kersom over 1 year ago. Updated 6 months ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Low
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Platform Release:
3.0.0
Blocks Release:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

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.

History

#1 Updated by amacdona@redhat.com 11 months ago

  • Subject changed from DRP OpenAPI body parameters description to Add DRF OpenAPI body parameters description

#3 Updated by amacdona@redhat.com 6 months 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

#4 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#5 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF