Skip to content

[Python] Fixed docstrings in api.mustache #6391

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 7 commits into from
Jun 4, 2020
Merged

[Python] Fixed docstrings in api.mustache #6391

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bd873ce
[Python] Fixed docstrings
Ark-kun May 22, 2020
8e0b887
Updated generated files
Ark-kun May 22, 2020
be86b62
Fixed python-experimental
Ark-kun May 22, 2020
deb8637
Updated generated files
Ark-kun May 22, 2020
7bafe11
Fully fixed the format of the docstrings
Ark-kun Jun 3, 2020
180be05
Updated generated files
Ark-kun Jun 3, 2020
69d75ce
Updated generated files in openapi3
Ark-kun Jun 3, 2020
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
Updated generated files
  • Loading branch information
@Ark-kun
Ark-kun committed May 22, 2020
commit 8e0b88769e7b144d87db3936addabddca08b0983
6 changes: 4 additions & 2 deletions samples/client/petstore/python-asyncio/petstore_api/api/another_fake_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ def call_123_test_special_tags(self, body, **kwargs): # noqa: E501
To test special tags and operation ID starting with number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.call_123_test_special_tags(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -67,10 +68,11 @@ def call_123_test_special_tags_with_http_info(self, body, **kwargs): # noqa: E5
To test special tags and operation ID starting with number # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Client body: client model (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down
84 changes: 56 additions & 28 deletions samples/client/petstore/python-asyncio/petstore_api/api/fake_api.py
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions samples/client/petstore/python-asyncio/petstore_api/api/fake_classname_tags_123_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ def test_classname(self, body, **kwargs): # noqa: E501
To test class name in snake case # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.test_classname(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -67,10 +68,11 @@ def test_classname_with_http_info(self, body, **kwargs): # noqa: E501
To test class name in snake case # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.test_classname_with_http_info(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Client body: client model (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down
54 changes: 36 additions & 18 deletions samples/client/petstore/python-asyncio/petstore_api/api/pet_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,11 @@ def add_pet(self, body, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_pet(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -65,10 +66,11 @@ def add_pet_with_http_info(self, body, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_pet_with_http_info(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down Expand Up @@ -153,10 +155,11 @@ def delete_pet(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_pet(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: Pet id to delete (required)
:param str api_key:
:param _preload_content: if False, the urllib3.HTTPResponse object will
Expand All @@ -178,10 +181,11 @@ def delete_pet_with_http_info(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_pet_with_http_info(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: Pet id to delete (required)
:param str api_key:
:param _return_http_data_only: response data without head status code
Expand Down Expand Up @@ -267,10 +271,11 @@ def find_pets_by_status(self, status, **kwargs): # noqa: E501
Multiple status values can be provided with comma separated strings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_pets_by_status(status, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -292,10 +297,11 @@ def find_pets_by_status_with_http_info(self, status, **kwargs): # noqa: E501
Multiple status values can be provided with comma separated strings # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_pets_by_status_with_http_info(status, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down Expand Up @@ -382,10 +388,11 @@ def find_pets_by_tags(self, tags, **kwargs): # noqa: E501
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_pets_by_tags(tags, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param list[str] tags: Tags to filter by (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -407,10 +414,11 @@ def find_pets_by_tags_with_http_info(self, tags, **kwargs): # noqa: E501
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param list[str] tags: Tags to filter by (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down Expand Up @@ -497,10 +505,11 @@ def get_pet_by_id(self, pet_id, **kwargs): # noqa: E501
Returns a single pet # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_pet_by_id(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to return (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -522,10 +531,11 @@ def get_pet_by_id_with_http_info(self, pet_id, **kwargs): # noqa: E501
Returns a single pet # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to return (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down Expand Up @@ -610,10 +620,11 @@ def update_pet(self, body, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_pet(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
Expand All @@ -634,10 +645,11 @@ def update_pet_with_http_info(self, body, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_pet_with_http_info(body, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
Expand Down Expand Up @@ -722,10 +734,11 @@ def update_pet_with_form(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_pet_with_form(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet
:param str status: Updated status of the pet
Expand All @@ -748,10 +761,11 @@ def update_pet_with_form_with_http_info(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet
:param str status: Updated status of the pet
Expand Down Expand Up @@ -844,10 +858,11 @@ def upload_file(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.upload_file(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server
:param file file: file to upload
Expand All @@ -870,10 +885,11 @@ def upload_file_with_http_info(self, pet_id, **kwargs): # noqa: E501

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.upload_file_with_http_info(pet_id, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server
:param file file: file to upload
Expand Down Expand Up @@ -970,10 +986,11 @@ def upload_file_with_required_file(self, pet_id, required_file, **kwargs): # no

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server
Expand All @@ -996,10 +1013,11 @@ def upload_file_with_required_file_with_http_info(self, pet_id, required_file, *

This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True)
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server
Expand Down
Loading