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

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
Next Next commit
[Python] Fixed docstrings 
Fixes swagger-api/swagger-codegen#9630
  • Loading branch information
@Ark-kun
Ark-kun authored May 22, 2020
commit bd873cee342e2d786f7c3318ef02750da06393f2
6 changes: 4 additions & 2 deletions modules/openapi-generator/src/main/resources/python/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class {{classname}}(object):
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

{{#sortParamsByRequiredFlag}}
>>> thread = api.{{operationId}}({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}async_req=True)
{{/sortParamsByRequiredFlag}}
Expand All @@ -46,7 +47,7 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}}
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
{{#allParams}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
{{/allParams}}
Expand All @@ -72,6 +73,7 @@ class {{classname}}(object):
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

{{#sortParamsByRequiredFlag}}
>>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}async_req=True)
{{/sortParamsByRequiredFlag}}
Expand All @@ -80,7 +82,7 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}}
>>> result = thread.get()

:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
{{#allParams}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}}
{{/allParams}}
Expand Down