Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix requestBody not wrapped in a schema in OpenAPI #6565

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.

Sign up for GitHub

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
merged 3 commits into from
Apr 4, 2019
Merged

Fix requestBody not wrapped in a schema in OpenAPI #6565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8010ca
Wrap requestBody contents in JSON schemas
Lucidiot Apr 4, 2019
5ff849b
Update unit test
Lucidiot Apr 4, 2019
0700776
Wrap response schemas in a schema object
Lucidiot Apr 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions rest_framework/schemas/inspectors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -770,7 +770,10 @@ def _get_request_body(self, path, method):
del content['properties'][name]

return {
'content': {ct: content for ct in self.content_types}
'content': {
ct: {'schema': content}
for ct in self.content_types
}
}

def _get_responses(self, path, method):
Expand All @@ -797,6 +800,9 @@ def _get_responses(self, path, method):

return {
'200': {
'content': {ct: content for ct in self.content_types}
'content': {
ct: {'schema': content}
for ct in self.content_types
}
}
}
10 changes: 5 additions & 5 deletions tests/schemas/test_openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def test_path_without_parameters(self):
assert operation == {
'operationId': 'ListExamples',
'parameters': [],
'responses': {'200': {'content': {'application/json': {}}}},
'responses': {'200': {'content': {'application/json': {'schema': {}}}}},
}

def test_path_with_id_parameter(self):
Expand Down Expand Up @@ -105,8 +105,8 @@ class View(generics.GenericAPIView):
inspector.view = view

request_body = inspector._get_request_body(path, method)
assert request_body['content']['application/json']['required'] == ['text']
assert list(request_body['content']['application/json']['properties'].keys()) == ['text']
assert request_body['content']['application/json']['schema']['required'] == ['text']
assert list(request_body['content']['application/json']['schema']['properties'].keys()) == ['text']

def test_response_body_generation(self):
path = '/'
Expand All @@ -128,8 +128,8 @@ class View(generics.GenericAPIView):
inspector.view = view

responses = inspector._get_responses(path, method)
assert responses['200']['content']['application/json']['required'] == ['text']
assert list(responses['200']['content']['application/json']['properties'].keys()) == ['text']
assert responses['200']['content']['application/json']['schema']['required'] == ['text']
assert list(responses['200']['content']['application/json']['schema']['properties'].keys()) == ['text']


@pytest.mark.skipif(uritemplate is None, reason='uritemplate not installed.')
Expand Down