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

Commit 5112884

Browse files
spacetherspacether
committed
Updates cookie_params, updates x_params to say key + input type
1 parent fe729ad commit 5112884

5 files changed

Lines changed: 52 additions & 52 deletions

File tree

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Name | Type | Description | Notes
6161
[path_params](#{{operationId}}.RequestPathParameters) | [RequestPathParameters.Params](#{{operationId}}.RequestPathParameters.Params) | |
6262
{{/if}}
6363
{{#if cookieParams}}
64-
cookie_params | RequestCookieParameters.Params | |
64+
[cookie_params](#{{operationId}}.RequestCookieParameters) | [RequestCookieParameters.Params](#{{operationId}}.RequestCookieParameters.Params) | |
6565
{{/if}}
6666
{{#with bodyParam}}
6767
{{#each content}}
@@ -93,7 +93,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
9393
### <a id="{{operationId}}.RequestQueryParameters" >query_params</a>
9494
#### <a id="{{operationId}}.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
9595
96-
Name | Type | Description | Notes
96+
Key | Input Type | Description | Notes
9797
------------- | ------------- | ------------- | -------------
9898
{{#each queryParams}}
9999
{{baseName}} | {{#with schema}}[RequestQueryParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{../../operationId}}.RequestQueryParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/with}} | | {{#unless required}}optional{{/unless}}
@@ -110,7 +110,7 @@ Name | Type | Description | Notes
110110
### <a id="{{operationId}}.RequestHeaderParameters" >header_params</a>
111111
#### <a id="{{operationId}}.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
112112
113-
Name | Type | Description | Notes
113+
Key | Input Type | Description | Notes
114114
------------- | ------------- | ------------- | -------------
115115
{{#each headerParams}}
116116
{{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}}
@@ -126,7 +126,7 @@ Name | Type | Description | Notes
126126
### <a id="{{operationId}}.RequestPathParameters" >path_params</a>
127127
#### <a id="{{operationId}}.RequestPathParameters.Params" >RequestPathParameters.Params</a>
128128
129-
Name | Type | Description | Notes
129+
Key | Input Type | Description | Notes
130130
------------- | ------------- | ------------- | -------------
131131
{{#each pathParams}}
132132
{{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}}
@@ -139,17 +139,17 @@ Name | Type | Description | Notes
139139
{{/if}}
140140
{{#if cookieParams}}
141141
142-
### cookie_params
143-
#### RequestCookieParameters.Params
142+
### <a id="{{operationId}}.RequestCookieParameters" >cookie_params</a>
143+
#### <a id="{{operationId}}.RequestCookieParameters.Params" >RequestCookieParameters.Params</a>
144144
145-
Name | Type | Description | Notes
145+
Key | Input Type | Description | Notes
146146
------------- | ------------- | ------------- | -------------
147147
{{#each cookieParams}}
148-
{{baseName}} | {{#with schema}}{{baseName}}{{/with}} | | {{#unless required}}optional{{/unless}}
148+
{{baseName}} | {{#with schema}}[RequestCookieParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}](#{{../../operationId}}.RequestCookieParameters.Schemas.{{#if nameInSnakeCase}}{{name}}{{else}}{{baseName}}{{/if}}){{/with}} | | {{#unless required}}optional{{/unless}}
149149
{{/each}}
150150
{{#each cookieParams}}
151151
{{#with schema}}
152-
{{> api_doc_schema_type_hint complexTypePrefix="../../models/" }}
152+
{{> api_doc_schema_type_hint anchorPrefix=../../operationId schemaNamePrefix1="RequestCookieParameters.Schemas." complexTypePrefix="../../models/" }}
153153
{{/with}}
154154
{{/each}}
155155
{{/if}}

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

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ Type | Description | Notes
433433
### <a id="body_with_query_params.RequestQueryParameters" >query_params</a>
434434
#### <a id="body_with_query_params.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
435435

436-
Name | Type | Description | Notes
436+
Key | Input Type | Description | Notes
437437
------------- | ------------- | ------------- | -------------
438438
query | [RequestQueryParameters.Schemas.query](#body_with_query_params.RequestQueryParameters.Schemas.query) | |
439439

@@ -592,7 +592,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
592592
### <a id="case_sensitive_params.RequestQueryParameters" >query_params</a>
593593
#### <a id="case_sensitive_params.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
594594

595-
Name | Type | Description | Notes
595+
Key | Input Type | Description | Notes
596596
------------- | ------------- | ------------- | -------------
597597
someVar | [RequestQueryParameters.Schemas.someVar](#case_sensitive_params.RequestQueryParameters.Schemas.someVar) | |
598598
SomeVar | [RequestQueryParameters.Schemas.SomeVar](#case_sensitive_params.RequestQueryParameters.Schemas.SomeVar) | |
@@ -850,7 +850,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
850850
### <a id="delete_coffee.RequestPathParameters" >path_params</a>
851851
#### <a id="delete_coffee.RequestPathParameters.Params" >RequestPathParameters.Params</a>
852852

853-
Name | Type | Description | Notes
853+
Key | Input Type | Description | Notes
854854
------------- | ------------- | ------------- | -------------
855855
id | [RequestPathParameters.Schemas.id](#delete_coffee.RequestPathParameters.Schemas.id) | |
856856

@@ -1115,7 +1115,7 @@ items | str, | str, | | must be one of [">", "$", ] if omitted the server wil
11151115
### <a id="enum_parameters.RequestQueryParameters" >query_params</a>
11161116
#### <a id="enum_parameters.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
11171117

1118-
Name | Type | Description | Notes
1118+
Key | Input Type | Description | Notes
11191119
------------- | ------------- | ------------- | -------------
11201120
enum_query_string_array | [RequestQueryParameters.Schemas.enum_query_string_array](#enum_parameters.RequestQueryParameters.Schemas.enum_query_string_array) | | optional
11211121
enum_query_string | [RequestQueryParameters.Schemas.enum_query_string](#enum_parameters.RequestQueryParameters.Schemas.enum_query_string) | | optional
@@ -1159,7 +1159,7 @@ decimal.Decimal, int, float, | decimal.Decimal, | | must be one of [1.1, -1.2
11591159
### <a id="enum_parameters.RequestHeaderParameters" >header_params</a>
11601160
#### <a id="enum_parameters.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
11611161

1162-
Name | Type | Description | Notes
1162+
Key | Input Type | Description | Notes
11631163
------------- | ------------- | ------------- | -------------
11641164
enum_header_string_array | [RequestHeaderParameters.Schemas.enum_header_string_array](#enum_parameters.RequestHeaderParameters.Schemas.enum_header_string_array) | | optional
11651165
enum_header_string | [RequestHeaderParameters.Schemas.enum_header_string](#enum_parameters.RequestHeaderParameters.Schemas.enum_header_string) | | optional
@@ -1354,7 +1354,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
13541354
### <a id="group_parameters.RequestQueryParameters" >query_params</a>
13551355
#### <a id="group_parameters.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
13561356

1357-
Name | Type | Description | Notes
1357+
Key | Input Type | Description | Notes
13581358
------------- | ------------- | ------------- | -------------
13591359
required_string_group | [RequestQueryParameters.Schemas.required_string_group](#group_parameters.RequestQueryParameters.Schemas.required_string_group) | |
13601360
required_int64_group | [RequestQueryParameters.Schemas.required_int64_group](#group_parameters.RequestQueryParameters.Schemas.required_int64_group) | |
@@ -1393,7 +1393,7 @@ decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
13931393
### <a id="group_parameters.RequestHeaderParameters" >header_params</a>
13941394
#### <a id="group_parameters.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
13951395

1396-
Name | Type | Description | Notes
1396+
Key | Input Type | Description | Notes
13971397
------------- | ------------- | ------------- | -------------
13981398
required_boolean_group | [RequestHeaderParameters.Schemas.required_boolean_group](#group_parameters.RequestHeaderParameters.Schemas.required_boolean_group) | |
13991399
boolean_group | [RequestHeaderParameters.Schemas.boolean_group](#group_parameters.RequestHeaderParameters.Schemas.boolean_group) | | optional
@@ -1620,7 +1620,7 @@ str, | str, | |
16201620
### <a id="inline_composition.RequestQueryParameters" >query_params</a>
16211621
#### <a id="inline_composition.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
16221622

1623-
Name | Type | Description | Notes
1623+
Key | Input Type | Description | Notes
16241624
------------- | ------------- | ------------- | -------------
16251625
compositionAtRoot | [RequestQueryParameters.Schemas.compositionAtRoot](#inline_composition.RequestQueryParameters.Schemas.compositionAtRoot) | | optional
16261626
compositionInProperty | [RequestQueryParameters.Schemas.compositionInProperty](#inline_composition.RequestQueryParameters.Schemas.compositionInProperty) | | optional
@@ -2198,7 +2198,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
21982198
### <a id="object_in_query.RequestQueryParameters" >query_params</a>
21992199
#### <a id="object_in_query.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
22002200

2201-
Name | Type | Description | Notes
2201+
Key | Input Type | Description | Notes
22022202
------------- | ------------- | ------------- | -------------
22032203
mapBean | [RequestQueryParameters.Schemas.mapBean](#object_in_query.RequestQueryParameters.Schemas.mapBean) | | optional
22042204

@@ -2417,7 +2417,7 @@ Name | Type | Description | Notes
24172417
[query_params](#parameter_collisions.RequestQueryParameters) | [RequestQueryParameters.Params](#parameter_collisions.RequestQueryParameters.Params) | |
24182418
[header_params](#parameter_collisions.RequestHeaderParameters) | [RequestHeaderParameters.Params](#parameter_collisions.RequestHeaderParameters.Params) | |
24192419
[path_params](#parameter_collisions.RequestPathParameters) | [RequestPathParameters.Params](#parameter_collisions.RequestPathParameters.Params) | |
2420-
cookie_params | RequestCookieParameters.Params | |
2420+
[cookie_params](#parameter_collisions.RequestCookieParameters) | [RequestCookieParameters.Params](#parameter_collisions.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
24232423
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
@@ -2436,7 +2436,7 @@ dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal
24362436
### <a id="parameter_collisions.RequestQueryParameters" >query_params</a>
24372437
#### <a id="parameter_collisions.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
24382438

2439-
Name | Type | Description | Notes
2439+
Key | Input Type | Description | Notes
24402440
------------- | ------------- | ------------- | -------------
24412441
1 | [RequestQueryParameters.Schemas._1](#parameter_collisions.RequestQueryParameters.Schemas._1) | | optional
24422442
aB | [RequestQueryParameters.Schemas.aB](#parameter_collisions.RequestQueryParameters.Schemas.aB) | | optional
@@ -2483,7 +2483,7 @@ str, | str, | |
24832483
### <a id="parameter_collisions.RequestHeaderParameters" >header_params</a>
24842484
#### <a id="parameter_collisions.RequestHeaderParameters.Params" >RequestHeaderParameters.Params</a>
24852485

2486-
Name | Type | Description | Notes
2486+
Key | Input Type | Description | Notes
24872487
------------- | ------------- | ------------- | -------------
24882488
1 | [RequestHeaderParameters.Schemas._1](#parameter_collisions.RequestHeaderParameters.Schemas._1) | | optional
24892489
aB | [RequestHeaderParameters.Schemas.aB](#parameter_collisions.RequestHeaderParameters.Schemas.aB) | | optional
@@ -2521,7 +2521,7 @@ str, | str, | |
25212521
### <a id="parameter_collisions.RequestPathParameters" >path_params</a>
25222522
#### <a id="parameter_collisions.RequestPathParameters.Params" >RequestPathParameters.Params</a>
25232523

2524-
Name | Type | Description | Notes
2524+
Key | Input Type | Description | Notes
25252525
------------- | ------------- | ------------- | -------------
25262526
1 | [RequestPathParameters.Schemas._1](#parameter_collisions.RequestPathParameters.Schemas._1) | |
25272527
aB | [RequestPathParameters.Schemas.aB](#parameter_collisions.RequestPathParameters.Schemas.aB) | |
@@ -2564,46 +2564,46 @@ Input Type | Accessed Type | Description | Notes
25642564
------------ | ------------- | ------------- | -------------
25652565
str, | str, | |
25662566

2567-
### cookie_params
2568-
#### RequestCookieParameters.Params
2567+
### <a id="parameter_collisions.RequestCookieParameters" >cookie_params</a>
2568+
#### <a id="parameter_collisions.RequestCookieParameters.Params" >RequestCookieParameters.Params</a>
25692569

2570-
Name | Type | Description | Notes
2570+
Key | Input Type | Description | Notes
25712571
------------- | ------------- | ------------- | -------------
2572-
1 | 1 | | optional
2573-
aB | aB | | optional
2574-
Ab | Ab | | optional
2575-
self | self | | optional
2576-
A-B | A-B | | optional
2572+
1 | [RequestCookieParameters.Schemas._1](#parameter_collisions.RequestCookieParameters.Schemas._1) | | optional
2573+
aB | [RequestCookieParameters.Schemas.aB](#parameter_collisions.RequestCookieParameters.Schemas.aB) | | optional
2574+
Ab | [RequestCookieParameters.Schemas.Ab](#parameter_collisions.RequestCookieParameters.Schemas.Ab) | | optional
2575+
self | [RequestCookieParameters.Schemas._self](#parameter_collisions.RequestCookieParameters.Schemas._self) | | optional
2576+
A-B | [RequestCookieParameters.Schemas.a_b](#parameter_collisions.RequestCookieParameters.Schemas.a_b) | | optional
25772577

2578-
# 1
2578+
# <a id="parameter_collisions.RequestCookieParameters.Schemas._1" >RequestCookieParameters.Schemas._1</a>
25792579

25802580
## Model Type Info
25812581
Input Type | Accessed Type | Description | Notes
25822582
------------ | ------------- | ------------- | -------------
25832583
str, | str, | |
25842584

2585-
# aB
2585+
# <a id="parameter_collisions.RequestCookieParameters.Schemas.aB" >RequestCookieParameters.Schemas.aB</a>
25862586

25872587
## Model Type Info
25882588
Input Type | Accessed Type | Description | Notes
25892589
------------ | ------------- | ------------- | -------------
25902590
str, | str, | |
25912591

2592-
# Ab
2592+
# <a id="parameter_collisions.RequestCookieParameters.Schemas.Ab" >RequestCookieParameters.Schemas.Ab</a>
25932593

25942594
## Model Type Info
25952595
Input Type | Accessed Type | Description | Notes
25962596
------------ | ------------- | ------------- | -------------
25972597
str, | str, | |
25982598

2599-
# self
2599+
# <a id="parameter_collisions.RequestCookieParameters.Schemas._self" >RequestCookieParameters.Schemas._self</a>
26002600

26012601
## Model Type Info
26022602
Input Type | Accessed Type | Description | Notes
26032603
------------ | ------------- | ------------- | -------------
26042604
str, | str, | |
26052605

2606-
# A-B
2606+
# <a id="parameter_collisions.RequestCookieParameters.Schemas.a_b" >RequestCookieParameters.Schemas.a_b</a>
26072607

26082608
## Model Type Info
26092609
Input Type | Accessed Type | Description | Notes
@@ -2685,7 +2685,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
26852685
### <a id="query_param_with_json_content_type.RequestQueryParameters" >query_params</a>
26862686
#### <a id="query_param_with_json_content_type.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
26872687

2688-
Name | Type | Description | Notes
2688+
Key | Input Type | Description | Notes
26892689
------------- | ------------- | ------------- | -------------
26902690
someParam | | |
26912691

@@ -2779,7 +2779,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
27792779
### <a id="query_parameter_collection_format.RequestQueryParameters" >query_params</a>
27802780
#### <a id="query_parameter_collection_format.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
27812781

2782-
Name | Type | Description | Notes
2782+
Key | Input Type | Description | Notes
27832783
------------- | ------------- | ------------- | -------------
27842784
pipe | [RequestQueryParameters.Schemas.pipe](#query_parameter_collection_format.RequestQueryParameters.Schemas.pipe) | |
27852785
ioutil | [RequestQueryParameters.Schemas.ioutil](#query_parameter_collection_format.RequestQueryParameters.Schemas.ioutil) | |
@@ -2924,7 +2924,7 @@ skip_deserialization | bool | default is False | when True, headers and body wil
29242924
### <a id="ref_object_in_query.RequestQueryParameters" >query_params</a>
29252925
#### <a id="ref_object_in_query.RequestQueryParameters.Params" >RequestQueryParameters.Params</a>
29262926

2927-
Name | Type | Description | Notes
2927+
Key | Input Type | Description | Notes
29282928
------------- | ------------- | ------------- | -------------
29292929
mapBean | [RequestQueryParameters.Schemas.mapBean](#ref_object_in_query.RequestQueryParameters.Schemas.mapBean) | | optional
29302930

0 commit comments

Comments
 (0)