v2 improve endpoint params code sample

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

@@ -10,6 +10,9 @@ from {{packageName}}.{{apiPackage}}.tags import {{moduleName}}
         {{/if}}
     {{/each}}
 {{/if}}
+{{#or pathParams queryParams headerParams cookieParams}}
+from {{packageName}}.paths.{{path.snakeCase}}.{{jsonPathPiece.original}} import operation
+{{/or}}
 {{#each imports}}
 {{{.}}}
 {{/each}}
@@ -31,7 +34,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
 
     # example passing only required values which don't have defaults set
     {{#if pathParams}}
-    path_params = {
+    path_params: operation.RequestPathParameters.Params = {
         {{#each pathParams}}
             {{#if refInfo}}
                 {{#if getDeepestRef.required}}
@@ -46,7 +49,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if queryParams}}
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         {{#each queryParams}}
             {{#if refInfo}}
                 {{#if getDeepestRef.required}}
@@ -61,7 +64,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if cookieParams}}
-    cookie_params = {
+    cookie_params: operation.RequestCookieParameters.Params = {
         {{#each cookieParams}}
             {{#if refInfo}}
                 {{#if getDeepestRef.required}}
@@ -76,7 +79,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if headerParams}}
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         {{#each headerParams}}
             {{#if refInfo}}
                 {{#if getDeepestRef.required}}
@@ -169,7 +172,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if queryParams}}
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         {{#each queryParams}}
             {{#if refInfo}}
         '{{getDeepestRef.name}}': {{{getDeepestRef.example}}},
@@ -180,7 +183,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if cookieParams}}
-    cookie_params = {
+    cookie_params: operation.RequestCookieParameters.Params = {
         {{#each cookieParams}}
             {{#if refInfo}}
         '{{getDeepestRef.name}}': {{{getDeepestRef.example}}},
@@ -191,7 +194,7 @@ with {{{packageName}}}.ApiClient(used_configuration) as api_client:
     }
     {{/if}}
     {{#if headerParams}}
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         {{#each headerParams}}
             {{#if refInfo}}
         '{{getDeepestRef.name}}': {{{getDeepestRef.example}}},

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

@@ -1,10 +1,7 @@
-REQUIREMENTS_FILE=dev-requirements.txt
-REQUIREMENTS_OUT=dev-requirements.txt.log
 SETUP_OUT=*.egg-info
 VENV=venv
 
 clean:
-	rm -rf $(REQUIREMENTS_OUT)
 	rm -rf $(SETUP_OUT)
 	rm -rf $(VENV)
 	rm -rf .tox

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

@@ -1,10 +1,7 @@
-REQUIREMENTS_FILE=dev-requirements.txt
-REQUIREMENTS_OUT=dev-requirements.txt.log
 SETUP_OUT=*.egg-info
 VENV=venv
 
 clean:
-	rm -rf $(REQUIREMENTS_OUT)
 	rm -rf $(SETUP_OUT)
 	rm -rf $(VENV)
 	rm -rf .tox

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

@@ -1,10 +1,7 @@
-REQUIREMENTS_FILE=dev-requirements.txt
-REQUIREMENTS_OUT=dev-requirements.txt.log
 SETUP_OUT=*.egg-info
 VENV=venv
 
 clean:
-	rm -rf $(REQUIREMENTS_OUT)
 	rm -rf $(SETUP_OUT)
 	rm -rf $(VENV)
 	rm -rf .tox

samples/openapi3/client/petstore/python/Makefile

@@ -1,10 +1,7 @@
-REQUIREMENTS_FILE=dev-requirements.txt
-REQUIREMENTS_OUT=dev-requirements.txt.log
 SETUP_OUT=*.egg-info
 VENV=venv
 
 clean:
-	rm -rf $(REQUIREMENTS_OUT)
 	rm -rf $(SETUP_OUT)
 	rm -rf $(VENV)
 	rm -rf .tox

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

@@ -169,6 +169,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake.delete import operation
 from pprint import pprint
 # security_index 0
 from petstore_api.components.security_schemes import security_scheme_bearer_test
@@ -189,11 +190,11 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'required_string_group': "required_string_group_example",
         'required_int64_group': 1,
     }
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         'required_boolean_group': "true",
     }
     try:
@@ -207,13 +208,13 @@ with petstore_api.ApiClient(used_configuration) as api_client:
         print("Exception when calling FakeApi->group_parameters: %s\n" % e)
 
     # example passing only optional values
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'required_string_group': "required_string_group_example",
         'required_int64_group': 1,
         'string_group': "string_group_example",
         'int64_group': 1,
     }
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         'required_boolean_group': "true",
         'boolean_group': "true",
     }

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

@@ -229,6 +229,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake.get import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -238,15 +239,15 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only optional values
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'enum_query_string_array': [
         "$"
     ],
         'enum_query_string': "-efg",
         'enum_query_integer': 1,
         'enum_query_double': 1.1,
     }
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         'enum_header_string_array': [
         "$"
     ],

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

@@ -91,6 +91,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_body_with_query_params.put import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -100,7 +101,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'query': "query_example",
     }
     body = user.User(

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

@@ -96,6 +96,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_case_sensitive_params.put import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -105,7 +106,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'someVar': "someVar_example",
         'SomeVar': "SomeVar_example",
         'some_var': "some_var_example",

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

@@ -93,6 +93,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_delete_coffee_id.delete import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -102,7 +103,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    path_params = {
+    path_params: operation.RequestPathParameters.Params = {
         'id': "id_example",
     }
     try:

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

@@ -263,6 +263,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_inline_composition.post import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -272,7 +273,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only optional values
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'compositionAtRoot': None,
         'compositionInProperty': dict(
         some_prop=None,

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

@@ -85,6 +85,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_obj_in_query.get import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -94,7 +95,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only optional values
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'mapBean': dict(
         keyword="keyword_example",
     ),

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

@@ -325,6 +325,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_parameter_collisions1_abab_self_ab.post import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -334,18 +335,18 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    path_params = {
+    path_params: operation.RequestPathParameters.Params = {
         '1': "1_example",
         'aB': "aB_example",
         'Ab': "Ab_example",
         'self': "self_example",
         'A-B': "A-B_example",
     }
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
     }
-    cookie_params = {
+    cookie_params: operation.RequestCookieParameters.Params = {
     }
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
     }
     try:
         # parameter collision case
@@ -367,21 +368,21 @@ with petstore_api.ApiClient(used_configuration) as api_client:
         'self': "self_example",
         'A-B': "A-B_example",
     }
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         '1': "1_example",
         'aB': "aB_example",
         'Ab': "Ab_example",
         'self': "self_example",
         'A-B': "A-B_example",
     }
-    cookie_params = {
+    cookie_params: operation.RequestCookieParameters.Params = {
         '1': "1_example",
         'aB': "aB_example",
         'Ab': "Ab_example",
         'self': "self_example",
         'A-B': "A-B_example",
     }
-    header_params = {
+    header_params: operation.RequestHeaderParameters.Params = {
         '1': "1_example",
         'aB': "aB_example",
         'self': "self_example",

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

@@ -143,6 +143,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import pet_api
+from petstore_api.paths.fake_pet_id_upload_image_with_required_file.post import operation
 from pprint import pprint
 # security_index 0
 from petstore_api.components.security_schemes import security_scheme_petstore_auth
@@ -162,7 +163,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = pet_api.PetApi(api_client)
 
     # example passing only required values which don't have defaults set
-    path_params = {
+    path_params: operation.RequestPathParameters.Params = {
         'petId': 1,
     }
     try:

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

@@ -109,6 +109,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_query_param_with_json_content_type.get import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -118,7 +119,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only required values which don't have defaults set
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'someParam': ,
     }
     try:

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

@@ -79,6 +79,7 @@ server_index | Class | Description
 import petstore_api
 from petstore_api.configurations import api_configuration
 from petstore_api.apis.tags import fake_api
+from petstore_api.paths.fake_ref_obj_in_query.get import operation
 from pprint import pprint
 used_configuration = api_configuration.ApiConfiguration(
 )
@@ -88,7 +89,7 @@ with petstore_api.ApiClient(used_configuration) as api_client:
     api_instance = fake_api.FakeApi(api_client)
 
     # example passing only optional values
-    query_params = {
+    query_params: operation.RequestQueryParameters.Params = {
         'mapBean': foo.Foo(
         bar=bar.Bar("bar"),
     ),