Pulp

Issue #3283

Updated by daviddavis almost 7 years ago

Looks like drf maps docstring for viewset actions to a description field in the api schema. For example, our artifacts delete action looks like this in the api schema: 

 <pre> 
                 "delete": { 
                     "_type": "link", 
                     "action": "delete", 
                     "description": "Remove :class:`~pulpcore.app.models.Artifact` only if it is not associated with any\n`~pulpcore.app.models.Content`\n\nArgs:\n      request (:class:`rest_framework.request.Request`): request containing JSON payload\n          with information about the artifact being deleted.\n      pk (:class:`uuid.UUID`): Unique id of the artifact being deleted.\n\nReturns:\n      :class:`rest_framework.response.Response` with a 204 status code in case of\n          successful deletion, 409 status code if deletion is not allowed.", 
 ... 
 } 
 </pre> 

 This is from the docstring on the action here: 

 https://github.com/pulp/pulp/blob/3.0-dev/pulpcore/pulpcore/app/viewsets/content.py#L86-L98 

 This is probably not very friendly for API users. Not sure what the solution here is. 

 Other endpoints with this problem include content create, status, etc.

Back