encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 17:09:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Minor docs tweaking

Browse Source
This commit is contained in:
Tom Christie 2019-12-12 13:31:22 +00:00
parent c8c792cc15
commit 352410fff2
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/community/3.11-announcement.md
View File

@ -38,8 +38,10 @@ include:
* Porting of the old CoreAPI parsing of docstrings to form OpenAPI operation * Porting of the old CoreAPI parsing of docstrings to form OpenAPI operation
descriptions. descriptions.
Here with an example view class: In this example view operation descriptions for the `get` and `post` methods will
be extracted from the class docstring:
```python
class DocStringExampleListView(APIView): class DocStringExampleListView(APIView):
""" """
get: A description of my GET operation. get: A description of my GET operation.
@ -47,14 +49,12 @@ include:
""" """
permission_classes = [permissions.IsAuthenticatedOrReadOnly] permission_classes = [permissions.IsAuthenticatedOrReadOnly]
def get(self, *args, **kwargs): def get(self, request, *args, **kwargs):
pass ...
def post(self, request, *args, **kwargs): def post(self, request, *args, **kwargs):
pass ...
```
Operation descriptions for the `get` and `post` methods will be extracted
from the class docstring.
## Validator / Default Context ## Validator / Default Context