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

OpenAPI: Added required description to responses. (#6850)

Browse Source
This commit is contained in:
Chris Vigelius 2019-08-07 22:09:27 +02:00 committed by Carlton Gibson
parent 0ebfbfdf81
commit f7dc6b5656
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rest_framework/schemas/openapi.py
View File

@ -490,6 +490,10 @@ class AutoSchema(ViewInspector):
'content': {
ct: {'schema': response_schema}
for ct in self.content_types
}
},
# description is a mandatory property,
# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject
# TODO: put something meaningful into it
'description': ""
}
}

4
tests/schemas/test_openapi.py
View File

@ -84,6 +84,7 @@ class TestOperationIntrospection(TestCase):
'parameters': [],
'responses': {
'200': {
'description': '',
'content': {
'application/json': {
'schema': {
@ -190,6 +191,7 @@ class TestOperationIntrospection(TestCase):
responses = inspector._get_responses(path, method)
assert responses['200']['content']['application/json']['schema']['required'] == ['text']
assert list(responses['200']['content']['application/json']['schema']['properties'].keys()) == ['text']
assert 'description' in responses['200']
def test_response_body_nested_serializer(self):
path = '/'
@ -243,6 +245,7 @@ class TestOperationIntrospection(TestCase):
responses = inspector._get_responses(path, method)
assert responses == {
'200': {
'description': '',
'content': {
'application/json': {
'schema': {
@ -283,6 +286,7 @@ class TestOperationIntrospection(TestCase):
responses = inspector._get_responses(path, method)
assert responses == {
'200': {
'description': '',
'content': {
'application/json': {
'schema': {