Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit d678771

Browse files
spacetherspacether
authored
v2 improve endpoint params code sample (#146)
* Adds type hints for path/query/cookie/header params in endpoint code samples * Samples regen * Simplifies makefiles
1 parent 016bd0d commit d678771

File tree

31 files changed

+73
-67
lines changed

31 files changed

+73
-67
lines changed

‎modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/_helper_operation_doc_example.hbs

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ from {{packageName}}.{{apiPackage}}.tags import {{moduleName}}
1010
{{/if}}
1111
{{/each}}
1212
{{/if}}
13+
{{#or pathParams queryParams headerParams cookieParams}}
14+
from {{packageName}}.paths.{{path.snakeCase}}.{{jsonPathPiece.original}} import operation
15+
{{/or}}
1316
{{#each imports}}
1417
{{{.}}}
1518
{{/each}}
@@ -31,7 +34,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
3134

3235
# example passing only required values which don't have defaults set
3336
{{#if pathParams}}
34-
path_params = {
37+
path_params: operation.RequestPathParameters.Params = {
3538
{{#each pathParams}}
3639
{{#if refInfo}}
3740
{{#if getDeepestRef.required}}
@@ -46,7 +49,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
4649
}
4750
{{/if}}
4851
{{#if queryParams}}
49-
query_params = {
52+
query_params: operation.RequestQueryParameters.Params = {
5053
{{#each queryParams}}
5154
{{#if refInfo}}
5255
{{#if getDeepestRef.required}}
@@ -61,7 +64,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
6164
}
6265
{{/if}}
6366
{{#if cookieParams}}
64-
cookie_params = {
67+
cookie_params: operation.RequestCookieParameters.Params = {
6568
{{#each cookieParams}}
6669
{{#if refInfo}}
6770
{{#if getDeepestRef.required}}
@@ -76,7 +79,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
7679
}
7780
{{/if}}
7881
{{#if headerParams}}
79-
header_params = {
82+
header_params: operation.RequestHeaderParameters.Params = {
8083
{{#each headerParams}}
8184
{{#if refInfo}}
8285
{{#if getDeepestRef.required}}
@@ -169,7 +172,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
169172
}
170173
{{/if}}
171174
{{#if queryParams}}
172-
query_params = {
175+
query_params: operation.RequestQueryParameters.Params = {
173176
{{#each queryParams}}
174177
{{#if refInfo}}
175178
'{{getDeepestRef.name}}': {{{getDeepestRef.example}}},
@@ -180,7 +183,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
180183
}
181184
{{/if}}
182185
{{#if cookieParams}}
183-
cookie_params = {
186+
cookie_params: operation.RequestCookieParameters.Params = {
184187
{{#each cookieParams}}
185188
{{#if refInfo}}
186189
'{{getDeepestRef.name}}': {{{getDeepestRef.example}}},
@@ -191,7 +194,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
191194
}
192195
{{/if}}
193196
{{#if headerParams}}
194-
header_params = {
197+
header_params: operation.RequestHeaderParameters.Params = {
195198
{{#each headerParams}}
196199
{{#if refInfo}}
197200
'{{getDeepestRef.name}}': {{{getDeepestRef.example}}},

‎samples/openapi3/client/3_0_3_unit_test/python/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
REQUIREMENTS_FILE=dev-requirements.txt
2-
REQUIREMENTS_OUT=dev-requirements.txt.log
31
SETUP_OUT=*.egg-info
42
VENV=venv
53

64
clean:
7-
rm -rf $(REQUIREMENTS_OUT)
85
rm -rf $(SETUP_OUT)
96
rm -rf $(VENV)
107
rm -rf .tox

‎samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
REQUIREMENTS_FILE=dev-requirements.txt
2-
REQUIREMENTS_OUT=dev-requirements.txt.log
31
SETUP_OUT=*.egg-info
42
VENV=venv
53

64
clean:
7-
rm -rf $(REQUIREMENTS_OUT)
85
rm -rf $(SETUP_OUT)
96
rm -rf $(VENV)
107
rm -rf .tox

‎samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/DefaultApi.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎samples/openapi3/client/features/security/python/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
REQUIREMENTS_FILE=dev-requirements.txt
2-
REQUIREMENTS_OUT=dev-requirements.txt.log
31
SETUP_OUT=*.egg-info
42
VENV=venv
53

64
clean:
7-
rm -rf $(REQUIREMENTS_OUT)
85
rm -rf $(SETUP_OUT)
96
rm -rf $(VENV)
107
rm -rf .tox

‎samples/openapi3/client/petstore/python/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
REQUIREMENTS_FILE=dev-requirements.txt
2-
REQUIREMENTS_OUT=dev-requirements.txt.log
31
SETUP_OUT=*.egg-info
42
VENV=venv
53

64
clean:
7-
rm -rf $(REQUIREMENTS_OUT)
85
rm -rf $(SETUP_OUT)
96
rm -rf $(VENV)
107
rm -rf .tox

‎samples/openapi3/client/petstore/python/docs/paths/fake/delete.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ server_index | Class | Description
169169
import petstore_api
170170
from petstore_api.configurations import api_configuration
171171
from petstore_api.apis.tags import fake_api
172+
from petstore_api.paths.fake.delete import operation
172173
from pprint import pprint
173174
# security_index 0
174175
from petstore_api.components.security_schemes import security_scheme_bearer_test
@@ -189,11 +190,11 @@ with petstore_api.ApiClient(used_configuration) as api_client:
189190
api_instance = fake_api.FakeApi(api_client)
190191

191192
# example passing only required values which don't have defaults set
192-
query_params = {
193+
query_params: operation.RequestQueryParameters.Params = {
193194
'required_string_group': "required_string_group_example",
194195
'required_int64_group': 1,
195196
}
196-
header_params = {
197+
header_params: operation.RequestHeaderParameters.Params = {
197198
'required_boolean_group': "true",
198199
}
199200
try:
@@ -207,13 +208,13 @@ with petstore_api.ApiClient(used_configuration) as api_client:
207208
print("Exception when calling FakeApi->group_parameters: %s\n" % e)
208209

209210
# example passing only optional values
210-
query_params = {
211+
query_params: operation.RequestQueryParameters.Params = {
211212
'required_string_group': "required_string_group_example",
212213
'required_int64_group': 1,
213214
'string_group': "string_group_example",
214215
'int64_group': 1,
215216
}
216-
header_params = {
217+
header_params: operation.RequestHeaderParameters.Params = {
217218
'required_boolean_group': "true",
218219
'boolean_group': "true",
219220
}

‎samples/openapi3/client/petstore/python/docs/paths/fake/get.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ server_index | Class | Description
229229
import petstore_api
230230
from petstore_api.configurations import api_configuration
231231
from petstore_api.apis.tags import fake_api
232+
from petstore_api.paths.fake.get import operation
232233
from pprint import pprint
233234
used_configuration = api_configuration.ApiConfiguration(
234235
)
@@ -238,15 +239,15 @@ with petstore_api.ApiClient(used_configuration) as api_client:
238239
api_instance = fake_api.FakeApi(api_client)
239240

240241
# example passing only optional values
241-
query_params = {
242+
query_params: operation.RequestQueryParameters.Params = {
242243
'enum_query_string_array': [
243244
"$"
244245
],
245246
'enum_query_string': "-efg",
246247
'enum_query_integer': 1,
247248
'enum_query_double': 1.1,
248249
}
249-
header_params = {
250+
header_params: operation.RequestHeaderParameters.Params = {
250251
'enum_header_string_array': [
251252
"$"
252253
],

‎samples/openapi3/client/petstore/python/docs/paths/fake_body_with_query_params/put.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ server_index | Class | Description
9191
import petstore_api
9292
from petstore_api.configurations import api_configuration
9393
from petstore_api.apis.tags import fake_api
94+
from petstore_api.paths.fake_body_with_query_params.put import operation
9495
from pprint import pprint
9596
used_configuration = api_configuration.ApiConfiguration(
9697
)
@@ -100,7 +101,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
100101
api_instance = fake_api.FakeApi(api_client)
101102

102103
# example passing only required values which don't have defaults set
103-
query_params = {
104+
query_params: operation.RequestQueryParameters.Params = {
104105
'query': "query_example",
105106
}
106107
body = user.User(

‎samples/openapi3/client/petstore/python/docs/paths/fake_case_sensitive_params/put.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ server_index | Class | Description
9696
import petstore_api
9797
from petstore_api.configurations import api_configuration
9898
from petstore_api.apis.tags import fake_api
99+
from petstore_api.paths.fake_case_sensitive_params.put import operation
99100
from pprint import pprint
100101
used_configuration = api_configuration.ApiConfiguration(
101102
)
@@ -105,7 +106,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
105106
api_instance = fake_api.FakeApi(api_client)
106107

107108
# example passing only required values which don't have defaults set
108-
query_params = {
109+
query_params: operation.RequestQueryParameters.Params = {
109110
'someVar': "someVar_example",
110111
'SomeVar': "SomeVar_example",
111112
'some_var': "some_var_example",

‎samples/openapi3/client/petstore/python/docs/paths/fake_delete_coffee_id/delete.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ server_index | Class | Description
9393
import petstore_api
9494
from petstore_api.configurations import api_configuration
9595
from petstore_api.apis.tags import fake_api
96+
from petstore_api.paths.fake_delete_coffee_id.delete import operation
9697
from pprint import pprint
9798
used_configuration = api_configuration.ApiConfiguration(
9899
)
@@ -102,7 +103,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
102103
api_instance = fake_api.FakeApi(api_client)
103104

104105
# example passing only required values which don't have defaults set
105-
path_params = {
106+
path_params: operation.RequestPathParameters.Params = {
106107
'id': "id_example",
107108
}
108109
try:

‎samples/openapi3/client/petstore/python/docs/paths/fake_inline_composition/post.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ server_index | Class | Description
263263
import petstore_api
264264
from petstore_api.configurations import api_configuration
265265
from petstore_api.apis.tags import fake_api
266+
from petstore_api.paths.fake_inline_composition.post import operation
266267
from pprint import pprint
267268
used_configuration = api_configuration.ApiConfiguration(
268269
)
@@ -272,7 +273,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
272273
api_instance = fake_api.FakeApi(api_client)
273274

274275
# example passing only optional values
275-
query_params = {
276+
query_params: operation.RequestQueryParameters.Params = {
276277
'compositionAtRoot': None,
277278
'compositionInProperty': dict(
278279
some_prop=None,

‎samples/openapi3/client/petstore/python/docs/paths/fake_obj_in_query/get.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ server_index | Class | Description
8585
import petstore_api
8686
from petstore_api.configurations import api_configuration
8787
from petstore_api.apis.tags import fake_api
88+
from petstore_api.paths.fake_obj_in_query.get import operation
8889
from pprint import pprint
8990
used_configuration = api_configuration.ApiConfiguration(
9091
)
@@ -94,7 +95,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
9495
api_instance = fake_api.FakeApi(api_client)
9596

9697
# example passing only optional values
97-
query_params = {
98+
query_params: operation.RequestQueryParameters.Params = {
9899
'mapBean': dict(
99100
keyword="keyword_example",
100101
),

‎samples/openapi3/client/petstore/python/docs/paths/fake_parameter_collisions1_abab_self_ab/post.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,7 @@ server_index | Class | Description
325325
import petstore_api
326326
from petstore_api.configurations import api_configuration
327327
from petstore_api.apis.tags import fake_api
328+
from petstore_api.paths.fake_parameter_collisions1_abab_self_ab.post import operation
328329
from pprint import pprint
329330
used_configuration = api_configuration.ApiConfiguration(
330331
)
@@ -334,18 +335,18 @@ with petstore_api.ApiClient(used_configuration) as api_client:
334335
api_instance = fake_api.FakeApi(api_client)
335336

336337
# example passing only required values which don't have defaults set
337-
path_params = {
338+
path_params: operation.RequestPathParameters.Params = {
338339
'1': "1_example",
339340
'aB': "aB_example",
340341
'Ab': "Ab_example",
341342
'self': "self_example",
342343
'A-B': "A-B_example",
343344
}
344-
query_params = {
345+
query_params: operation.RequestQueryParameters.Params = {
345346
}
346-
cookie_params = {
347+
cookie_params: operation.RequestCookieParameters.Params = {
347348
}
348-
header_params = {
349+
header_params: operation.RequestHeaderParameters.Params = {
349350
}
350351
try:
351352
# parameter collision case
@@ -367,21 +368,21 @@ with petstore_api.ApiClient(used_configuration) as api_client:
367368
'self': "self_example",
368369
'A-B': "A-B_example",
369370
}
370-
query_params = {
371+
query_params: operation.RequestQueryParameters.Params = {
371372
'1': "1_example",
372373
'aB': "aB_example",
373374
'Ab': "Ab_example",
374375
'self': "self_example",
375376
'A-B': "A-B_example",
376377
}
377-
cookie_params = {
378+
cookie_params: operation.RequestCookieParameters.Params = {
378379
'1': "1_example",
379380
'aB': "aB_example",
380381
'Ab': "Ab_example",
381382
'self': "self_example",
382383
'A-B': "A-B_example",
383384
}
384-
header_params = {
385+
header_params: operation.RequestHeaderParameters.Params = {
385386
'1': "1_example",
386387
'aB': "aB_example",
387388
'self': "self_example",

‎samples/openapi3/client/petstore/python/docs/paths/fake_pet_id_upload_image_with_required_file/post.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ server_index | Class | Description
143143
import petstore_api
144144
from petstore_api.configurations import api_configuration
145145
from petstore_api.apis.tags import pet_api
146+
from petstore_api.paths.fake_pet_id_upload_image_with_required_file.post import operation
146147
from pprint import pprint
147148
# security_index 0
148149
from petstore_api.components.security_schemes import security_scheme_petstore_auth
@@ -162,7 +163,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
162163
api_instance = pet_api.PetApi(api_client)
163164

164165
# example passing only required values which don't have defaults set
165-
path_params = {
166+
path_params: operation.RequestPathParameters.Params = {
166167
'petId': 1,
167168
}
168169
try:

‎samples/openapi3/client/petstore/python/docs/paths/fake_query_param_with_json_content_type/get.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ server_index | Class | Description
109109
import petstore_api
110110
from petstore_api.configurations import api_configuration
111111
from petstore_api.apis.tags import fake_api
112+
from petstore_api.paths.fake_query_param_with_json_content_type.get import operation
112113
from pprint import pprint
113114
used_configuration = api_configuration.ApiConfiguration(
114115
)
@@ -118,7 +119,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
118119
api_instance = fake_api.FakeApi(api_client)
119120

120121
# example passing only required values which don't have defaults set
121-
query_params = {
122+
query_params: operation.RequestQueryParameters.Params = {
122123
'someParam': ,
123124
}
124125
try:

‎samples/openapi3/client/petstore/python/docs/paths/fake_ref_obj_in_query/get.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ server_index | Class | Description
7979
import petstore_api
8080
from petstore_api.configurations import api_configuration
8181
from petstore_api.apis.tags import fake_api
82+
from petstore_api.paths.fake_ref_obj_in_query.get import operation
8283
from pprint import pprint
8384
used_configuration = api_configuration.ApiConfiguration(
8485
)
@@ -88,7 +89,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
8889
api_instance = fake_api.FakeApi(api_client)
8990

9091
# example passing only optional values
91-
query_params = {
92+
query_params: operation.RequestQueryParameters.Params = {
9293
'mapBean': foo.Foo(
9394
bar=bar.Bar("bar"),
9495
),

0 commit comments

Comments
 (0)