django-rest-framework icon indicating copy to clipboard operation
django-rest-framework copied to clipboard

Open API now supplies a summary of operations

Open C0DK opened this issue 5 years ago • 1 comments

refs #7319

sumary

It was annoying to me that DRF doesn't fill the summary field on OpenAPI. So I created a quick and dirty solution, in the hopes of getting some feedback and then inacting that.

The Change

Creates a summary field on all operations on OpenAPI

This would create summaries on a snippet endpoint like List Of Snippets, Create Snippet and any action extra_action would be Extra Action Snippet. if you have a docstring it will use the first line of that instead.

Description

This is a minimal solution to https://github.com/encode/django-rest-framework/issues/7319, however i am not completly sure if my __doc__ solution is great - it might even be a bit annoying. It was my quick implementation of what i read from the PEP, however I've probably missed something.

C0DK avatar May 08 '20 19:05 C0DK

If you guys like the change, then i'll fix all the tests :)

C0DK avatar May 08 '20 20:05 C0DK

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Aug 12 '22 05:08 stale[bot]

Closing given lack of interaction against the issue. Thanks for your time on the proposal, tho.

tomchristie avatar Aug 12 '22 11:08 tomchristie