Skip to content

[python-experimental] Allow response media types to omit schema #12135

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
spacether merged 10 commits into from
Apr 13, 2022
Merged

[python-experimental] Allow response media types to omit schema #12135

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
66da49c
Adds issue spec file and attemts to generate code from it
spacether Apr 12, 2022
7a7fd2d
Adds missing schema definitions
spacether Apr 12, 2022
0309aa4
Skips fromProperty invocation if the passed in schema is none in getC…
spacether Apr 13, 2022
8a18944
Makes MediaType.schema optional
spacether Apr 13, 2022
2454205
Adds checking that the content type is in self.content
spacether Apr 13, 2022
8655d1c
Sets ApiResponse body type as Unset if there is no schema for it
spacether Apr 13, 2022
d6cd2d7
Handles schema = None case
spacether Apr 13, 2022
b656a02
Adds endpoint without response schema
spacether Apr 13, 2022
9365758
Reverts version files
spacether Apr 13, 2022
abd486d
Adds test_response_without_schema
spacether Apr 13, 2022
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
Prev Previous commit
Next Next commit
Handles schema = None case
  • Loading branch information
@spacether
spacether committed Apr 13, 2022
commit d6cd2d7cd27fb4cb0281ee4b44b4ccb49b482852
21 changes: 15 additions & 6 deletions modules/openapi-generator/src/main/resources/python-experimental/api_client.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,12 +803,27 @@ class OpenApiResponse(JSONDetector):
content_type = response.getheader('content-type')
deserialized_body = unset
streamed = response.supports_chunked_reads()

deserialized_headers = unset
if self.headers is not None:
# TODO add header deserialiation here
pass

if self.content is not None:
if content_type not in self.content:
raise ApiValueError(
f'Invalid content_type={content_type} returned for response with '
'status_code={str(response.status)}'
)
body_schema = self.content[content_type].schema
if body_schema is None:
# some specs do not define response content media type schemas
return self.response_cls(
response=response,
headers=deserialized_headers,
body=unset
)

if self.content_type_is_json(content_type):
body_data = self.__deserialize_json(response)
elif content_type == 'application/octet-stream':
Expand All @@ -818,17 +833,11 @@ class OpenApiResponse(JSONDetector):
content_type = 'multipart/form-data'
else:
raise NotImplementedError('Deserialization of {} has not yet been implemented'.format(content_type))
# TODO if body_schema is None what should the code do?
body_schema = self.content[content_type].schema
deserialized_body = body_schema._from_openapi_data(
body_data, _configuration=configuration)
elif streamed:
response.release_conn()

deserialized_headers = unset
if self.headers is not None:
deserialized_headers = unset

return self.response_cls(
response=response,
headers=deserialized_headers,
Expand Down
21 changes: 15 additions & 6 deletions samples/openapi3/client/petstore/python-experimental-issue-11763/petstore_api/api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -808,12 +808,27 @@ def deserialize(self, response: urllib3.HTTPResponse, configuration: Configurati
content_type = response.getheader('content-type')
deserialized_body = unset
streamed = response.supports_chunked_reads()

deserialized_headers = unset
if self.headers is not None:
# TODO add header deserialiation here
pass

if self.content is not None:
if content_type not in self.content:
raise ApiValueError(
f'Invalid content_type={content_type} returned for response with '
'status_code={str(response.status)}'
)
body_schema = self.content[content_type].schema
if body_schema is None:
# some specs do not define response content media type schemas
return self.response_cls(
response=response,
headers=deserialized_headers,
body=unset
)

if self.content_type_is_json(content_type):
body_data = self.__deserialize_json(response)
elif content_type == 'application/octet-stream':
Expand All @@ -823,17 +838,11 @@ def deserialize(self, response: urllib3.HTTPResponse, configuration: Configurati
content_type = 'multipart/form-data'
else:
raise NotImplementedError('Deserialization of {} has not yet been implemented'.format(content_type))
# TODO if body_schema is None what should the code do?
body_schema = self.content[content_type].schema
deserialized_body = body_schema._from_openapi_data(
body_data, _configuration=configuration)
elif streamed:
response.release_conn()

deserialized_headers = unset
if self.headers is not None:
deserialized_headers = unset

return self.response_cls(
response=response,
headers=deserialized_headers,
Expand Down