Skip to content

OpenAPI: Ported docstring operation description from CoreAPI inspector. #6898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ysavary
Copy link
Contributor

@ysavary ysavary commented Aug 29, 2019

I would like to document my operation with a description as a docstring comment like it was with coreapi.

Copy link
Collaborator

@carltongibson carltongibson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ysavary.

Really happy to see this done, but instead of duplicating the code from the coreapi module, please can you bring it up into the base ViewInspector class.

Also, please could you go over the comments and code to make sure they make sense in a non-CoreAPI context? (For example, talk of Links is using CoreAPI terminology.)

Other than that, yes, super! 👍

Copy link
Collaborator

@carltongibson carltongibson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, this looks like a nice addition. Thank you.

@carltongibson carltongibson added this to the 3.11 Release milestone Nov 6, 2019
@carltongibson carltongibson changed the title Ported docstring operation description from coreapi OpenAPI: Ported docstring operation description from CoreAPI inspector. Nov 6, 2019
@carltongibson carltongibson merged commit 7c3477d into encode:master Nov 6, 2019
pchiquet pushed a commit to pchiquet/django-rest-framework that referenced this pull request Nov 17, 2020
sigvef pushed a commit to sigvef/django-rest-framework that referenced this pull request Dec 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants