Skip to content

Commit 00a9cfd

Browse files
cognifloydwing328
authored andcommitted
Python: Update api_doc_example for multiple auth (#1870)
APIs may more than one auth method (for example both an app key and basic auth). This changes the example to only initialize the config option once instead of once per auth method.
1 parent 4fa9266 commit 00a9cfd

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

modules/openapi-generator/src/main/resources/python/api_doc_example.mustache

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,16 @@ import time
44
import {{{packageName}}}
55
from {{{packageName}}}.rest import ApiException
66
from pprint import pprint
7-
{{#hasAuthMethods}}{{#isBasic}}
7+
{{#hasAuthMethods}}
8+
configuration = {{{packageName}}}.Configuration(){{#isBasic}}
89
# Configure HTTP basic authorization: {{{name}}}
9-
configuration = {{{packageName}}}.Configuration()
1010
configuration.username = 'YOUR_USERNAME'
1111
configuration.password = 'YOUR_PASSWORD'{{/isBasic}}{{#isApiKey}}
1212
# Configure API key authorization: {{{name}}}
13-
configuration = {{{packageName}}}.Configuration()
1413
configuration.api_key['{{{keyParamName}}}'] = 'YOUR_API_KEY'
1514
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1615
# configuration.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
1716
# Configure OAuth2 access token for authorization: {{{name}}}
18-
configuration = {{{packageName}}}.Configuration()
1917
configuration.access_token = 'YOUR_ACCESS_TOKEN'{{/isOAuth}}
2018

2119
# create an instance of the API class

modules/openapi-generator/src/main/resources/python/common_README.mustache

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,16 @@ import time
44
import {{{packageName}}}
55
from {{{packageName}}}.rest import ApiException
66
from pprint import pprint
7-
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}}
7+
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}
8+
configuration = {{{packageName}}}.Configuration(){{#isBasic}}
89
# Configure HTTP basic authorization: {{{name}}}
9-
configuration = {{{packageName}}}.Configuration()
1010
configuration.username = 'YOUR_USERNAME'
1111
configuration.password = 'YOUR_PASSWORD'{{/isBasic}}{{#isApiKey}}
1212
# Configure API key authorization: {{{name}}}
13-
configuration = {{{packageName}}}.Configuration()
1413
configuration.api_key['{{{keyParamName}}}'] = 'YOUR_API_KEY'
1514
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1615
# configuration.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
1716
# Configure OAuth2 access token for authorization: {{{name}}}
18-
configuration = {{{packageName}}}.Configuration()
1917
configuration.access_token = 'YOUR_ACCESS_TOKEN'{{/isOAuth}}{{/authMethods}}
2018
{{/hasAuthMethods}}
2119

0 commit comments

Comments
 (0)