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

Commit fe729ad

Browse files
spacetherspacether
committed
Updates path_parameters
1 parent 788b7d8 commit fe729ad

5 files changed

Lines changed: 73 additions & 73 deletions

File tree

‎modules/openapi-json-schema-generator/src/main/resources/python/api_doc.handlebars‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
5858
[header_params](#{{operationId}}.RequestHeaderParameters) | [RequestHeaderParameters.Params](#{{operationId}}.RequestHeaderParameters.Params) | |
5959
{{/if}}
6060
{{#if pathParams}}
61-
path_params | RequestPathParameters.Params | |
61+
[path_params](#{{operationId}}.RequestPathParameters) | [RequestPathParameters.Params](#{{operationId}}.RequestPathParameters.Params) | |
6262
{{/if}}
6363
{{#if cookieParams}}
6464
cookie_params | RequestCookieParameters.Params | |
@@ -123,17 +123,17 @@ Name | Type | Description | Notes
123123
{{/if}}
124124
{{#if pathParams}}
125125
126-
### path_params
127-
#### RequestPathParameters.Params
126+
### <a id="{{operationId}}.RequestPathParameters" >path_params</a>
127+
#### <a id="{{operationId}}.RequestPathParameters.Params" >RequestPathParameters.Params</a>
128128
129129
Name | Type | Description | Notes
130130
------------- | ------------- | ------------- | -------------
131131
{{#each pathParams}}
132-
{{baseName}} | {{#with schema}}{{baseName}}{{/with}} | | {{#unless required}}optional{{/unless}}
132+
{{baseName}} | {{#with schema}}[RequestPathParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{../../operationId}}.RequestPathParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/with}} | | {{#unless required}}optional{{/unless}}
133133
{{/each}}
134134
{{#each pathParams}}
135135
{{#with schema}}
136-
{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
136+
{{> api_doc_schema_type_hint anchorPrefix=../../operationId schemaNamePrefix1="RequestPathParameters.Schemas." complexTypePrefix="../../models/" }}
137137
{{/with}}
138138
{{/each}}
139139
{{/if}}

‎samples/openapi3/client/petstore/python/docs/apis/tags/FakeApi.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -842,19 +842,19 @@ with petstore_api.ApiClient(configuration) as api_client:
842842

843843
Name | Type | Description | Notes
844844
------------- | ------------- | ------------- | -------------
845-
path_params | RequestPathParameters.Params | |
845+
[path_params](#delete_coffee.RequestPathParameters) | [RequestPathParameters.Params](#delete_coffee.RequestPathParameters.Params) | |
846846
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
847847
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
848848
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
849849

850-
### path_params
851-
#### RequestPathParameters.Params
850+
### <a id="delete_coffee.RequestPathParameters" >path_params</a>
851+
#### <a id="delete_coffee.RequestPathParameters.Params" >RequestPathParameters.Params</a>
852852

853853
Name | Type | Description | Notes
854854
------------- | ------------- | ------------- | -------------
855-
id | id | |
855+
id | [RequestPathParameters.Schemas.id](#delete_coffee.RequestPathParameters.Schemas.id) | |
856856

857-
# id
857+
# <a id="delete_coffee.RequestPathParameters.Schemas.id" >RequestPathParameters.Schemas.id</a>
858858

859859
## Model Type Info
860860
Input Type | Accessed Type | Description | Notes
@@ -2416,7 +2416,7 @@ Name | Type | Description | Notes
24162416
[body](#parameter_collisions.RequestBody) | typing.Union[[RequestBody.Schemas.application_json](#parameter_collisions.RequestBody.Schemas.application_json), Unset] | optional, default is unset |
24172417
[query_params](#parameter_collisions.RequestQueryParameters) | [RequestQueryParameters.Params](#parameter_collisions.RequestQueryParameters.Params) | |
24182418
[header_params](#parameter_collisions.RequestHeaderParameters) | [RequestHeaderParameters.Params](#parameter_collisions.RequestHeaderParameters.Params) | |
2419-
path_params | RequestPathParameters.Params | |
2419+
[path_params](#parameter_collisions.RequestPathParameters) | [RequestPathParameters.Params](#parameter_collisions.RequestPathParameters.Params) | |
24202420
cookie_params | RequestCookieParameters.Params | |
24212421
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
24222422
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
@@ -2518,46 +2518,46 @@ Input Type | Accessed Type | Description | Notes
25182518
------------ | ------------- | ------------- | -------------
25192519
str, | str, | |
25202520

2521-
### path_params
2522-
#### RequestPathParameters.Params
2521+
### <a id="parameter_collisions.RequestPathParameters" >path_params</a>
2522+
#### <a id="parameter_collisions.RequestPathParameters.Params" >RequestPathParameters.Params</a>
25232523

25242524
Name | Type | Description | Notes
25252525
------------- | ------------- | ------------- | -------------
2526-
1 | 1 | |
2527-
aB | aB | |
2528-
Ab | Ab | |
2529-
self | self | |
2530-
A-B | A-B | |
2526+
1 | [RequestPathParameters.Schemas._1](#parameter_collisions.RequestPathParameters.Schemas._1) | |
2527+
aB | [RequestPathParameters.Schemas.aB](#parameter_collisions.RequestPathParameters.Schemas.aB) | |
2528+
Ab | [RequestPathParameters.Schemas.Ab](#parameter_collisions.RequestPathParameters.Schemas.Ab) | |
2529+
self | [RequestPathParameters.Schemas._self](#parameter_collisions.RequestPathParameters.Schemas._self) | |
2530+
A-B | [RequestPathParameters.Schemas.a_b](#parameter_collisions.RequestPathParameters.Schemas.a_b) | |
25312531

2532-
# 1
2532+
# <a id="parameter_collisions.RequestPathParameters.Schemas._1" >RequestPathParameters.Schemas._1</a>
25332533

25342534
## Model Type Info
25352535
Input Type | Accessed Type | Description | Notes
25362536
------------ | ------------- | ------------- | -------------
25372537
str, | str, | |
25382538

2539-
# aB
2539+
# <a id="parameter_collisions.RequestPathParameters.Schemas.aB" >RequestPathParameters.Schemas.aB</a>
25402540

25412541
## Model Type Info
25422542
Input Type | Accessed Type | Description | Notes
25432543
------------ | ------------- | ------------- | -------------
25442544
str, | str, | |
25452545

2546-
# Ab
2546+
# <a id="parameter_collisions.RequestPathParameters.Schemas.Ab" >RequestPathParameters.Schemas.Ab</a>
25472547

25482548
## Model Type Info
25492549
Input Type | Accessed Type | Description | Notes
25502550
------------ | ------------- | ------------- | -------------
25512551
str, | str, | |
25522552

2553-
# self
2553+
# <a id="parameter_collisions.RequestPathParameters.Schemas._self" >RequestPathParameters.Schemas._self</a>
25542554

25552555
## Model Type Info
25562556
Input Type | Accessed Type | Description | Notes
25572557
------------ | ------------- | ------------- | -------------
25582558
str, | str, | |
25592559

2560-
# A-B
2560+
# <a id="parameter_collisions.RequestPathParameters.Schemas.a_b" >RequestPathParameters.Schemas.a_b</a>
25612561

25622562
## Model Type Info
25632563
Input Type | Accessed Type | Description | Notes

‎samples/openapi3/client/petstore/python/docs/apis/tags/PetApi.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ with petstore_api.ApiClient(configuration) as api_client:
260260
Name | Type | Description | Notes
261261
------------- | ------------- | ------------- | -------------
262262
[header_params](#delete_pet.RequestHeaderParameters) | [RequestHeaderParameters.Params](#delete_pet.RequestHeaderParameters.Params) | |
263-
path_params | RequestPathParameters.Params | |
263+
[path_params](#delete_pet.RequestPathParameters) | [RequestPathParameters.Params](#delete_pet.RequestPathParameters.Params) | |
264264
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
265265
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
266266
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -279,14 +279,14 @@ Input Type | Accessed Type | Description | Notes
279279
------------ | ------------- | ------------- | -------------
280280
str, | str, | |
281281

282-
### path_params
283-
#### RequestPathParameters.Params
282+
### <a id="delete_pet.RequestPathParameters" >path_params</a>
283+
#### <a id="delete_pet.RequestPathParameters.Params" >RequestPathParameters.Params</a>
284284

285285
Name | Type | Description | Notes
286286
------------- | ------------- | ------------- | -------------
287-
petId | petId | |
287+
petId | [RequestPathParameters.Schemas.petId](#delete_pet.RequestPathParameters.Schemas.petId) | |
288288

289-
# petId
289+
# <a id="delete_pet.RequestPathParameters.Schemas.petId" >RequestPathParameters.Schemas.petId</a>
290290

291291
## Model Type Info
292292
Input Type | Accessed Type | Description | Notes
@@ -749,20 +749,20 @@ with petstore_api.ApiClient(configuration) as api_client:
749749

750750
Name | Type | Description | Notes
751751
------------- | ------------- | ------------- | -------------
752-
path_params | RequestPathParameters.Params | |
752+
[path_params](#get_pet_by_id.RequestPathParameters) | [RequestPathParameters.Params](#get_pet_by_id.RequestPathParameters.Params) | |
753753
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
754754
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
755755
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
756756
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
757757

758-
### path_params
759-
#### RequestPathParameters.Params
758+
### <a id="get_pet_by_id.RequestPathParameters" >path_params</a>
759+
#### <a id="get_pet_by_id.RequestPathParameters.Params" >RequestPathParameters.Params</a>
760760

761761
Name | Type | Description | Notes
762762
------------- | ------------- | ------------- | -------------
763-
petId | petId | |
763+
petId | [RequestPathParameters.Schemas.petId](#get_pet_by_id.RequestPathParameters.Schemas.petId) | |
764764

765-
# petId
765+
# <a id="get_pet_by_id.RequestPathParameters.Schemas.petId" >RequestPathParameters.Schemas.petId</a>
766766

767767
## Model Type Info
768768
Input Type | Accessed Type | Description | Notes
@@ -1066,7 +1066,7 @@ with petstore_api.ApiClient(configuration) as api_client:
10661066
Name | Type | Description | Notes
10671067
------------- | ------------- | ------------- | -------------
10681068
[body](#update_pet_with_form.RequestBody) | typing.Union[[RequestBody.Schemas.application_x_www_form_urlencoded](#update_pet_with_form.RequestBody.Schemas.application_x_www_form_urlencoded), Unset] | optional, default is unset |
1069-
path_params | RequestPathParameters.Params | |
1069+
[path_params](#update_pet_with_form.RequestPathParameters) | [RequestPathParameters.Params](#update_pet_with_form.RequestPathParameters.Params) | |
10701070
content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body
10711071
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
10721072
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
@@ -1088,14 +1088,14 @@ Key | Input Type | Accessed Type | Description | Notes
10881088
**status** | str, | str, | Updated status of the pet | [optional]
10891089
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
10901090

1091-
### path_params
1092-
#### RequestPathParameters.Params
1091+
### <a id="update_pet_with_form.RequestPathParameters" >path_params</a>
1092+
#### <a id="update_pet_with_form.RequestPathParameters.Params" >RequestPathParameters.Params</a>
10931093

10941094
Name | Type | Description | Notes
10951095
------------- | ------------- | ------------- | -------------
1096-
petId | petId | |
1096+
petId | [RequestPathParameters.Schemas.petId](#update_pet_with_form.RequestPathParameters.Schemas.petId) | |
10971097

1098-
# petId
1098+
# <a id="update_pet_with_form.RequestPathParameters.Schemas.petId" >RequestPathParameters.Schemas.petId</a>
10991099

11001100
## Model Type Info
11011101
Input Type | Accessed Type | Description | Notes
@@ -1191,7 +1191,7 @@ with petstore_api.ApiClient(configuration) as api_client:
11911191
Name | Type | Description | Notes
11921192
------------- | ------------- | ------------- | -------------
11931193
[body](#upload_file_with_required_file.RequestBody) | typing.Union[[RequestBody.Schemas.multipart_form_data](#upload_file_with_required_file.RequestBody.Schemas.multipart_form_data), Unset] | optional, default is unset |
1194-
path_params | RequestPathParameters.Params | |
1194+
[path_params](#upload_file_with_required_file.RequestPathParameters) | [RequestPathParameters.Params](#upload_file_with_required_file.RequestPathParameters.Params) | |
11951195
content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body
11961196
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
11971197
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
@@ -1214,14 +1214,14 @@ Key | Input Type | Accessed Type | Description | Notes
12141214
**additionalMetadata** | str, | str, | Additional data to pass to server | [optional]
12151215
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
12161216

1217-
### path_params
1218-
#### RequestPathParameters.Params
1217+
### <a id="upload_file_with_required_file.RequestPathParameters" >path_params</a>
1218+
#### <a id="upload_file_with_required_file.RequestPathParameters.Params" >RequestPathParameters.Params</a>
12191219

12201220
Name | Type | Description | Notes
12211221
------------- | ------------- | ------------- | -------------
1222-
petId | petId | |
1222+
petId | [RequestPathParameters.Schemas.petId](#upload_file_with_required_file.RequestPathParameters.Schemas.petId) | |
12231223

1224-
# petId
1224+
# <a id="upload_file_with_required_file.RequestPathParameters.Schemas.petId" >RequestPathParameters.Schemas.petId</a>
12251225

12261226
## Model Type Info
12271227
Input Type | Accessed Type | Description | Notes
@@ -1323,7 +1323,7 @@ with petstore_api.ApiClient(configuration) as api_client:
13231323
Name | Type | Description | Notes
13241324
------------- | ------------- | ------------- | -------------
13251325
[body](#upload_image.RequestBody) | typing.Union[[RequestBody.Schemas.multipart_form_data](#upload_image.RequestBody.Schemas.multipart_form_data), Unset] | optional, default is unset |
1326-
path_params | RequestPathParameters.Params | |
1326+
[path_params](#upload_image.RequestPathParameters) | [RequestPathParameters.Params](#upload_image.RequestPathParameters.Params) | |
13271327
content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body
13281328
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
13291329
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
@@ -1346,14 +1346,14 @@ Key | Input Type | Accessed Type | Description | Notes
13461346
**file** | bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | file to upload | [optional]
13471347
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
13481348

1349-
### path_params
1350-
#### RequestPathParameters.Params
1349+
### <a id="upload_image.RequestPathParameters" >path_params</a>
1350+
#### <a id="upload_image.RequestPathParameters.Params" >RequestPathParameters.Params</a>
13511351

13521352
Name | Type | Description | Notes
13531353
------------- | ------------- | ------------- | -------------
1354-
petId | petId | |
1354+
petId | [RequestPathParameters.Schemas.petId](#upload_image.RequestPathParameters.Schemas.petId) | |
13551355

1356-
# petId
1356+
# <a id="upload_image.RequestPathParameters.Schemas.petId" >RequestPathParameters.Schemas.petId</a>
13571357

13581358
## Model Type Info
13591359
Input Type | Accessed Type | Description | Notes

‎samples/openapi3/client/petstore/python/docs/apis/tags/StoreApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,19 @@ with petstore_api.ApiClient(configuration) as api_client:
5050

5151
Name | Type | Description | Notes
5252
------------- | ------------- | ------------- | -------------
53-
path_params | RequestPathParameters.Params | |
53+
[path_params](#delete_order.RequestPathParameters) | [RequestPathParameters.Params](#delete_order.RequestPathParameters.Params) | |
5454
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
5555
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
5656
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
5757

58-
### path_params
59-
#### RequestPathParameters.Params
58+
### <a id="delete_order.RequestPathParameters" >path_params</a>
59+
#### <a id="delete_order.RequestPathParameters.Params" >RequestPathParameters.Params</a>
6060

6161
Name | Type | Description | Notes
6262
------------- | ------------- | ------------- | -------------
63-
order_id | order_id | |
63+
order_id | [RequestPathParameters.Schemas.order_id](#delete_order.RequestPathParameters.Schemas.order_id) | |
6464

65-
# order_id
65+
# <a id="delete_order.RequestPathParameters.Schemas.order_id" >RequestPathParameters.Schemas.order_id</a>
6666

6767
## Model Type Info
6868
Input Type | Accessed Type | Description | Notes
@@ -216,20 +216,20 @@ with petstore_api.ApiClient(configuration) as api_client:
216216

217217
Name | Type | Description | Notes
218218
------------- | ------------- | ------------- | -------------
219-
path_params | RequestPathParameters.Params | |
219+
[path_params](#get_order_by_id.RequestPathParameters) | [RequestPathParameters.Params](#get_order_by_id.RequestPathParameters.Params) | |
220220
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
221221
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
222222
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
223223
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
224224

225-
### path_params
226-
#### RequestPathParameters.Params
225+
### <a id="get_order_by_id.RequestPathParameters" >path_params</a>
226+
#### <a id="get_order_by_id.RequestPathParameters.Params" >RequestPathParameters.Params</a>
227227

228228
Name | Type | Description | Notes
229229
------------- | ------------- | ------------- | -------------
230-
order_id | order_id | |
230+
order_id | [RequestPathParameters.Schemas.order_id](#get_order_by_id.RequestPathParameters.Schemas.order_id) | |
231231

232-
# order_id
232+
# <a id="get_order_by_id.RequestPathParameters.Schemas.order_id" >RequestPathParameters.Schemas.order_id</a>
233233

234234
## Model Type Info
235235
Input Type | Accessed Type | Description | Notes

0 commit comments

Comments
 (0)