Project

Profile

Help

Task #3302

closed

Add DRF OpenAPI body parameters description

Added by kersom about 6 years ago. Updated almost 5 years ago.

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

Actions #1

Updated by amacdona@redhat.com over 5 years ago

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

Updated by amacdona@redhat.com almost 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 #4

Updated by daviddavis almost 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions #5

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3)

Also available in: Atom PDF