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

Commit 788b7d8

Browse files
spacetherspacether
committed
Updates header_params
1 parent 7cbeed6 commit 788b7d8

3 files changed

Lines changed: 35 additions & 35 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
@@ -55,7 +55,7 @@ Name | Type | Description | Notes
5555
[query_params](#{{operationId}}.RequestQueryParameters) | [RequestQueryParameters.Params](#{{operationId}}.RequestQueryParameters.Params) | |
5656
{{/if}}
5757
{{#if headerParams}}
58-
header_params | RequestHeaderParameters.Params | |
58+
[header_params](#{{operationId}}.RequestHeaderParameters) | [RequestHeaderParameters.Params](#{{operationId}}.RequestHeaderParameters.Params) | |
5959
{{/if}}
6060
{{#if pathParams}}
6161
path_params | RequestPathParameters.Params | |
@@ -107,17 +107,17 @@ Name | Type | Description | Notes
107107
{{/if}}
108108
{{#if headerParams}}
109109
110-
### header_params
111-
#### RequestHeaderParameters.Params
110+
### <a id="{{operationId}}.RequestHeaderParameters" >header_params</a>
111+
#### <a id="{{operationId}}.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
112112
113113
Name | Type | Description | Notes
114114
------------- | ------------- | ------------- | -------------
115115
{{#each headerParams}}
116-
{{baseName}} | {{#with schema}}{{baseName}}{{/with}} | | {{#unless required}}optional{{/unless}}
116+
{{baseName}} | {{#with schema}}[RequestHeaderParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{../../operationId}}.RequestHeaderParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/with}} | | {{#unless required}}optional{{/unless}}
117117
{{/each}}
118118
{{#each headerParams}}
119119
{{#with schema}}
120-
{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
120+
{{> api_doc_schema_type_hint anchorPrefix=../../operationId schemaNamePrefix1="RequestHeaderParameters.Schemas." complexTypePrefix="../../models/" }}
121121
{{/with}}
122122
{{/each}}
123123
{{/if}}

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,7 +1076,7 @@ Name | Type | Description | Notes
10761076
------------- | ------------- | ------------- | -------------
10771077
[body](#enum_parameters.RequestBody) | typing.Union[[RequestBody.Schemas.application_x_www_form_urlencoded](#enum_parameters.RequestBody.Schemas.application_x_www_form_urlencoded), Unset] | optional, default is unset |
10781078
[query_params](#enum_parameters.RequestQueryParameters) | [RequestQueryParameters.Params](#enum_parameters.RequestQueryParameters.Params) | |
1079-
header_params | RequestHeaderParameters.Params | |
1079+
[header_params](#enum_parameters.RequestHeaderParameters) | [RequestHeaderParameters.Params](#enum_parameters.RequestHeaderParameters.Params) | |
10801080
content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body
10811081
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
10821082
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
@@ -1156,15 +1156,15 @@ Input Type | Accessed Type | Description | Notes
11561156
------------ | ------------- | ------------- | -------------
11571157
decimal.Decimal, int, float, | decimal.Decimal, | | must be one of [1.1, -1.2, ] value must be a 64 bit float
11581158

1159-
### header_params
1160-
#### RequestHeaderParameters.Params
1159+
### <a id="enum_parameters.RequestHeaderParameters" >header_params</a>
1160+
#### <a id="enum_parameters.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
11611161

11621162
Name | Type | Description | Notes
11631163
------------- | ------------- | ------------- | -------------
1164-
enum_header_string_array | enum_header_string_array | | optional
1165-
enum_header_string | enum_header_string | | optional
1164+
enum_header_string_array | [RequestHeaderParameters.Schemas.enum_header_string_array](#enum_parameters.RequestHeaderParameters.Schemas.enum_header_string_array) | | optional
1165+
enum_header_string | [RequestHeaderParameters.Schemas.enum_header_string](#enum_parameters.RequestHeaderParameters.Schemas.enum_header_string) | | optional
11661166

1167-
# enum_header_string_array
1167+
# <a id="enum_parameters.RequestHeaderParameters.Schemas.enum_header_string_array" >RequestHeaderParameters.Schemas.enum_header_string_array</a>
11681168

11691169
## Model Type Info
11701170
Input Type | Accessed Type | Description | Notes
@@ -1176,7 +1176,7 @@ Class Name | Input Type | Accessed Type | Description | Notes
11761176
------------- | ------------- | ------------- | ------------- | -------------
11771177
items | str, | str, | | must be one of [">", "$", ] if omitted the server will use the default value of "$"
11781178

1179-
# enum_header_string
1179+
# <a id="enum_parameters.RequestHeaderParameters.Schemas.enum_header_string" >RequestHeaderParameters.Schemas.enum_header_string</a>
11801180

11811181
## Model Type Info
11821182
Input Type | Accessed Type | Description | Notes
@@ -1346,7 +1346,7 @@ with petstore_api.ApiClient(configuration) as api_client:
13461346
Name | Type | Description | Notes
13471347
------------- | ------------- | ------------- | -------------
13481348
[query_params](#group_parameters.RequestQueryParameters) | [RequestQueryParameters.Params](#group_parameters.RequestQueryParameters.Params) | |
1349-
header_params | RequestHeaderParameters.Params | |
1349+
[header_params](#group_parameters.RequestHeaderParameters) | [RequestHeaderParameters.Params](#group_parameters.RequestHeaderParameters.Params) | |
13501350
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
13511351
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
13521352
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -1390,22 +1390,22 @@ Input Type | Accessed Type | Description | Notes
13901390
------------ | ------------- | ------------- | -------------
13911391
decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
13921392

1393-
### header_params
1394-
#### RequestHeaderParameters.Params
1393+
### <a id="group_parameters.RequestHeaderParameters" >header_params</a>
1394+
#### <a id="group_parameters.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
13951395

13961396
Name | Type | Description | Notes
13971397
------------- | ------------- | ------------- | -------------
1398-
required_boolean_group | required_boolean_group | |
1399-
boolean_group | boolean_group | | optional
1398+
required_boolean_group | [RequestHeaderParameters.Schemas.required_boolean_group](#group_parameters.RequestHeaderParameters.Schemas.required_boolean_group) | |
1399+
boolean_group | [RequestHeaderParameters.Schemas.boolean_group](#group_parameters.RequestHeaderParameters.Schemas.boolean_group) | | optional
14001400

1401-
# required_boolean_group
1401+
# <a id="group_parameters.RequestHeaderParameters.Schemas.required_boolean_group" >RequestHeaderParameters.Schemas.required_boolean_group</a>
14021402

14031403
## Model Type Info
14041404
Input Type | Accessed Type | Description | Notes
14051405
------------ | ------------- | ------------- | -------------
14061406
bool, | BoolClass, | |
14071407

1408-
# boolean_group
1408+
# <a id="group_parameters.RequestHeaderParameters.Schemas.boolean_group" >RequestHeaderParameters.Schemas.boolean_group</a>
14091409

14101410
## Model Type Info
14111411
Input Type | Accessed Type | Description | Notes
@@ -2415,7 +2415,7 @@ Name | Type | Description | Notes
24152415
------------- | ------------- | ------------- | -------------
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) | |
2418-
header_params | RequestHeaderParameters.Params | |
2418+
[header_params](#parameter_collisions.RequestHeaderParameters) | [RequestHeaderParameters.Params](#parameter_collisions.RequestHeaderParameters.Params) | |
24192419
path_params | 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
@@ -2480,38 +2480,38 @@ Input Type | Accessed Type | Description | Notes
24802480
------------ | ------------- | ------------- | -------------
24812481
str, | str, | |
24822482

2483-
### header_params
2484-
#### RequestHeaderParameters.Params
2483+
### <a id="parameter_collisions.RequestHeaderParameters" >header_params</a>
2484+
#### <a id="parameter_collisions.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
24852485

24862486
Name | Type | Description | Notes
24872487
------------- | ------------- | ------------- | -------------
2488-
1 | 1 | | optional
2489-
aB | aB | | optional
2490-
self | self | | optional
2491-
A-B | A-B | | optional
2488+
1 | [RequestHeaderParameters.Schemas._1](#parameter_collisions.RequestHeaderParameters.Schemas._1) | | optional
2489+
aB | [RequestHeaderParameters.Schemas.aB](#parameter_collisions.RequestHeaderParameters.Schemas.aB) | | optional
2490+
self | [RequestHeaderParameters.Schemas._self](#parameter_collisions.RequestHeaderParameters.Schemas._self) | | optional
2491+
A-B | [RequestHeaderParameters.Schemas.a_b](#parameter_collisions.RequestHeaderParameters.Schemas.a_b) | | optional
24922492

2493-
# 1
2493+
# <a id="parameter_collisions.RequestHeaderParameters.Schemas._1" >RequestHeaderParameters.Schemas._1</a>
24942494

24952495
## Model Type Info
24962496
Input Type | Accessed Type | Description | Notes
24972497
------------ | ------------- | ------------- | -------------
24982498
str, | str, | |
24992499

2500-
# aB
2500+
# <a id="parameter_collisions.RequestHeaderParameters.Schemas.aB" >RequestHeaderParameters.Schemas.aB</a>
25012501

25022502
## Model Type Info
25032503
Input Type | Accessed Type | Description | Notes
25042504
------------ | ------------- | ------------- | -------------
25052505
str, | str, | |
25062506

2507-
# self
2507+
# <a id="parameter_collisions.RequestHeaderParameters.Schemas._self" >RequestHeaderParameters.Schemas._self</a>
25082508

25092509
## Model Type Info
25102510
Input Type | Accessed Type | Description | Notes
25112511
------------ | ------------- | ------------- | -------------
25122512
str, | str, | |
25132513

2514-
# A-B
2514+
# <a id="parameter_collisions.RequestHeaderParameters.Schemas.a_b" >RequestHeaderParameters.Schemas.a_b</a>
25152515

25162516
## Model Type Info
25172517
Input Type | Accessed Type | Description | Notes

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -259,20 +259,20 @@ with petstore_api.ApiClient(configuration) as api_client:
259259

260260
Name | Type | Description | Notes
261261
------------- | ------------- | ------------- | -------------
262-
header_params | RequestHeaderParameters.Params | |
262+
[header_params](#delete_pet.RequestHeaderParameters) | [RequestHeaderParameters.Params](#delete_pet.RequestHeaderParameters.Params) | |
263263
path_params | 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
267267

268-
### header_params
269-
#### RequestHeaderParameters.Params
268+
### <a id="delete_pet.RequestHeaderParameters" >header_params</a>
269+
#### <a id="delete_pet.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
270270

271271
Name | Type | Description | Notes
272272
------------- | ------------- | ------------- | -------------
273-
api_key | api_key | | optional
273+
api_key | [RequestHeaderParameters.Schemas.api_key](#delete_pet.RequestHeaderParameters.Schemas.api_key) | | optional
274274

275-
# api_key
275+
# <a id="delete_pet.RequestHeaderParameters.Schemas.api_key" >RequestHeaderParameters.Schemas.api_key</a>
276276

277277
## Model Type Info
278278
Input Type | Accessed Type | Description | Notes

0 commit comments

Comments
 (0)