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

Infer description from property docstring

Browse Source
This commit is contained in:
Charles Cunningham 2020-05-28 09:07:15 -04:00
parent acbd9d8222
commit a00d43be50
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rest_framework/schemas/openapi.py
View File

@ -2,6 +2,7 @@ import re
import warnings
from collections import OrderedDict
from decimal import Decimal
from inspect import getdoc
from operator import attrgetter
from urllib.parse import urljoin
@ -284,6 +285,11 @@ class AutoSchema(ViewInspector):
elif model_field is not None and model_field.primary_key:
description = get_pk_description(model, model_field)
if model_field is None and variable in model.__dict__.keys() and \
isinstance(model.__dict__[variable], property):
doc = getdoc(model.__dict__[variable])
description = '' if doc is None else doc
parameter = {
"name": variable,
"in": "path",