Task #3302: Add DRF OpenAPI body parameters description - Pulp

Actions

Send by e-mail Copy link

Task #3302

closed

Add DRF OpenAPI body parameters description

Added by kersom almost 7 years ago. Updated over 5 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Low

Assignee:

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

% Done:

Estimated time:

Platform Release:

3.0.0

Groomed:

Sprint Candidate:

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

Copy link

Updated by amacdona@redhat.com about 6 years ago

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

Actions

Copy link

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

Actions

Copy link

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.