Project

Profile

Help

Task #3302

closed

Add DRF OpenAPI body parameters description

Added by kersom about 5 years ago. Updated almost 4 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.

Also available in: Atom PDF