loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-08 05:46:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Python] 5094 followup - Reduce redundancy in docs (#5161)

Browse Source 
* Reduce redundancy in python docs

This is a followup to PR #5094, which had a few unresolved comments at
merge time. This reduces the amount of redundant lines in the api
example doc templates, and ensures that referenced Configuration objects
are actually instantiated.

* Regenerate samples
This commit is contained in:
Fabian von Feilitzsch
2020-02-06 13:58:17 -08:00
committed by GitHub
parent 197cea3248
commit c943ecfe28
32 changed files with 133 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
samples/client/petstore/python-experimental/docs/AnotherFakeApi.md
View File

@@ -23,7 +23,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.AnotherFakeApi(api_client)
body = petstore_api.Client() # client.Client | client model

29
samples/client/petstore/python-experimental/docs/FakeApi.md
View File

@@ -37,7 +37,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
xml_item = petstore_api.XmlItem() # xml_item.XmlItem | XmlItem Body
@@ -92,7 +92,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = True # bool | Input boolean as post body (optional)
@@ -148,7 +148,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = petstore_api.OuterComposite() # outer_composite.OuterComposite | Input composite as post body (optional)
@@ -204,7 +204,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = petstore_api.OuterEnum("placed") # outer_enum.OuterEnum | Input enum as post body (optional)
@@ -260,7 +260,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = petstore_api.OuterNumber(3.4) # outer_number.OuterNumber | Input number as post body (optional)
@@ -316,7 +316,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = 'body_example' # str | Input string as post body (optional)
@@ -372,7 +372,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = petstore_api.FileSchemaTestClass() # file_schema_test_class.FileSchemaTestClass |
@@ -424,7 +424,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
query = 'query_example' # str |
@@ -480,7 +480,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
body = petstore_api.Client() # client.Client | client model
@@ -536,7 +536,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
@@ -599,6 +599,7 @@ configuration.password = 'YOUR_PASSWORD'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -690,7 +691,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
enum_header_string_array = ['enum_header_string_array_example'] # [str] | Header parameter enum test (string array) (optional)
@@ -761,7 +762,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
required_string_group = 56 # int | Required String in group parameters
@@ -832,7 +833,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
param = {'key': 'param_example'} # {str: (str,)} | request body
@@ -885,7 +886,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeApi(api_client)
param = 'param_example' # str | field1

1
samples/client/petstore/python-experimental/docs/FakeClassnameTags123Api.md
View File

@@ -30,6 +30,7 @@ configuration.api_key['api_key_query'] = 'YOUR_API_KEY'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class

9
samples/client/petstore/python-experimental/docs/PetApi.md
View File

@@ -34,6 +34,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -94,6 +95,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -166,6 +168,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -229,6 +232,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -294,6 +298,7 @@ configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -356,6 +361,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -418,6 +424,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -489,6 +496,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -564,6 +572,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class

7
samples/client/petstore/python-experimental/docs/StoreApi.md
View File

@@ -26,7 +26,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
order_id = 'order_id_example' # str | ID of the order that needs to be deleted
@@ -89,6 +89,7 @@ configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Defining host is optional and default to http://petstore.swagger.io:80/v2
configuration.host = "http://petstore.swagger.io:80/v2"
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
@@ -142,7 +143,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
order_id = 56 # int | ID of pet that needs to be fetched
@@ -198,7 +199,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
body = petstore_api.Order() # order.Order | order placed for purchasing the pet

16
samples/client/petstore/python-experimental/docs/UserApi.md
View File

@@ -30,7 +30,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
body = petstore_api.User() # user.User | Created user object
@@ -83,7 +83,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
body = [petstore_api.User()] # [user.User] | List of user object
@@ -136,7 +136,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
body = [petstore_api.User()] # [user.User] | List of user object
@@ -191,7 +191,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The name that needs to be deleted
@@ -245,7 +245,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The name that needs to be fetched. Use user1 for testing.
@@ -301,7 +301,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The user name for login
@@ -358,7 +358,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
@@ -409,7 +409,7 @@ import petstore_api
from pprint import pprint
# Enter a context with an instance of the API client
with petstore_api.ApiClient(configuration) as api_client:
with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | name that need to be deleted