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

Commit 6c91e9e

Browse files
spacetherspacether
authored
Adds security_index info to endpoint docs (#181)
* Adds security_index info to endpoint docs * Fixes endpoint doc servers link * Removes typo from endpoint doc args * Adds server_index info to docs * Fixes exnpoint dc link to root servers * Requires the secuirty and servers keys in config typeddicts * Adds security_index_info to docs * Updates samples * Samples regenerated
1 parent f161d38 commit 6c91e9e

File tree

248 files changed

+841
-681
lines changed
  • modules/openapi-json-schema-generator/src/main/resources/python
  • samples/openapi3/client
    • 3_0_3_unit_test/python
      • docs/paths
        • request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body
        • request_body_post_additionalproperties_are_allowed_by_default_request_body
        • request_body_post_additionalproperties_can_exist_by_itself_request_body
        • request_body_post_additionalproperties_should_not_look_in_applicators_request_body
        • request_body_post_allof_combined_with_anyof_oneof_request_body
        • request_body_post_allof_request_body
        • request_body_post_allof_simple_types_request_body
        • request_body_post_allof_with_base_schema_request_body
        • request_body_post_allof_with_one_empty_schema_request_body
        • request_body_post_allof_with_the_first_empty_schema_request_body
        • request_body_post_allof_with_the_last_empty_schema_request_body
        • request_body_post_allof_with_two_empty_schemas_request_body
        • request_body_post_anyof_complex_types_request_body
        • request_body_post_anyof_request_body
        • request_body_post_anyof_with_base_schema_request_body
        • request_body_post_anyof_with_one_empty_schema_request_body
        • request_body_post_array_type_matches_arrays_request_body
        • request_body_post_boolean_type_matches_booleans_request_body
        • request_body_post_by_int_request_body
        • request_body_post_by_number_request_body
        • request_body_post_by_small_number_request_body
        • request_body_post_date_time_format_request_body
        • request_body_post_email_format_request_body
        • request_body_post_enum_with0_does_not_match_false_request_body
        • request_body_post_enum_with1_does_not_match_true_request_body
        • request_body_post_enum_with_escaped_characters_request_body
        • request_body_post_enum_with_false_does_not_match0_request_body
        • request_body_post_enum_with_true_does_not_match1_request_body
        • request_body_post_enums_in_properties_request_body
        • request_body_post_forbidden_property_request_body
        • request_body_post_hostname_format_request_body
        • request_body_post_integer_type_matches_integers_request_body
        • request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body
        • request_body_post_invalid_string_value_for_default_request_body
        • request_body_post_ipv4_format_request_body
        • request_body_post_ipv6_format_request_body
        • request_body_post_json_pointer_format_request_body
        • request_body_post_maximum_validation_request_body
        • request_body_post_maximum_validation_with_unsigned_integer_request_body
        • request_body_post_maxitems_validation_request_body
        • request_body_post_maxlength_validation_request_body
        • request_body_post_maxproperties0_means_the_object_is_empty_request_body
        • request_body_post_maxproperties_validation_request_body
        • request_body_post_minimum_validation_request_body
        • request_body_post_minimum_validation_with_signed_integer_request_body
        • request_body_post_minitems_validation_request_body
        • request_body_post_minlength_validation_request_body
        • request_body_post_minproperties_validation_request_body
        • request_body_post_nested_allof_to_check_validation_semantics_request_body
        • request_body_post_nested_anyof_to_check_validation_semantics_request_body
        • request_body_post_nested_items_request_body
        • request_body_post_nested_oneof_to_check_validation_semantics_request_body
        • request_body_post_not_more_complex_schema_request_body
        • request_body_post_not_request_body
        • request_body_post_nul_characters_in_strings_request_body
        • request_body_post_null_type_matches_only_the_null_object_request_body
        • request_body_post_number_type_matches_numbers_request_body
        • request_body_post_object_properties_validation_request_body
        • request_body_post_object_type_matches_objects_request_body
        • request_body_post_oneof_complex_types_request_body
        • request_body_post_oneof_request_body
        • request_body_post_oneof_with_base_schema_request_body
        • request_body_post_oneof_with_empty_schema_request_body
        • request_body_post_oneof_with_required_request_body
        • request_body_post_pattern_is_not_anchored_request_body
        • request_body_post_pattern_validation_request_body
        • request_body_post_properties_with_escaped_characters_request_body
        • request_body_post_property_named_ref_that_is_not_a_reference_request_body
        • request_body_post_ref_in_additionalproperties_request_body
        • request_body_post_ref_in_allof_request_body
        • request_body_post_ref_in_anyof_request_body
        • request_body_post_ref_in_items_request_body
        • request_body_post_ref_in_not_request_body
        • request_body_post_ref_in_oneof_request_body
        • request_body_post_ref_in_property_request_body
        • request_body_post_required_default_validation_request_body
        • request_body_post_required_validation_request_body
        • request_body_post_required_with_empty_array_request_body
        • request_body_post_required_with_escaped_characters_request_body
        • request_body_post_simple_enum_validation_request_body
        • request_body_post_string_type_matches_strings_request_body
        • request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body
        • request_body_post_uniqueitems_false_validation_request_body
        • request_body_post_uniqueitems_validation_request_body
        • request_body_post_uri_format_request_body
        • request_body_post_uri_reference_format_request_body
        • request_body_post_uri_template_format_request_body
        • response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types
        • response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types
        • response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types
        • response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types
        • response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types
        • response_body_post_allof_response_body_for_content_types
        • response_body_post_allof_simple_types_response_body_for_content_types
        • response_body_post_allof_with_base_schema_response_body_for_content_types
        • response_body_post_allof_with_one_empty_schema_response_body_for_content_types
        • response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types
        • response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types
        • response_body_post_allof_with_two_empty_schemas_response_body_for_content_types
        • response_body_post_anyof_complex_types_response_body_for_content_types
        • response_body_post_anyof_response_body_for_content_types
        • response_body_post_anyof_with_base_schema_response_body_for_content_types
        • response_body_post_anyof_with_one_empty_schema_response_body_for_content_types
        • response_body_post_array_type_matches_arrays_response_body_for_content_types
        • response_body_post_boolean_type_matches_booleans_response_body_for_content_types
        • response_body_post_by_int_response_body_for_content_types
        • response_body_post_by_number_response_body_for_content_types
        • response_body_post_by_small_number_response_body_for_content_types
        • response_body_post_date_time_format_response_body_for_content_types
        • response_body_post_email_format_response_body_for_content_types
        • response_body_post_enum_with0_does_not_match_false_response_body_for_content_types
        • response_body_post_enum_with1_does_not_match_true_response_body_for_content_types
        • response_body_post_enum_with_escaped_characters_response_body_for_content_types
        • response_body_post_enum_with_false_does_not_match0_response_body_for_content_types
        • response_body_post_enum_with_true_does_not_match1_response_body_for_content_types
        • response_body_post_enums_in_properties_response_body_for_content_types
        • response_body_post_forbidden_property_response_body_for_content_types
        • response_body_post_hostname_format_response_body_for_content_types
        • response_body_post_integer_type_matches_integers_response_body_for_content_types
        • response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types
        • response_body_post_invalid_string_value_for_default_response_body_for_content_types
        • response_body_post_ipv4_format_response_body_for_content_types
        • response_body_post_ipv6_format_response_body_for_content_types
        • response_body_post_json_pointer_format_response_body_for_content_types
        • response_body_post_maximum_validation_response_body_for_content_types
        • response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types
        • response_body_post_maxitems_validation_response_body_for_content_types
        • response_body_post_maxlength_validation_response_body_for_content_types
        • response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types
        • response_body_post_maxproperties_validation_response_body_for_content_types
        • response_body_post_minimum_validation_response_body_for_content_types
        • response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types
        • response_body_post_minitems_validation_response_body_for_content_types
        • response_body_post_minlength_validation_response_body_for_content_types
        • response_body_post_minproperties_validation_response_body_for_content_types
        • response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types
        • response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types
        • response_body_post_nested_items_response_body_for_content_types
        • response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types
        • response_body_post_not_more_complex_schema_response_body_for_content_types
        • response_body_post_not_response_body_for_content_types
        • response_body_post_nul_characters_in_strings_response_body_for_content_types
        • response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types
        • response_body_post_number_type_matches_numbers_response_body_for_content_types
        • response_body_post_object_properties_validation_response_body_for_content_types
        • response_body_post_object_type_matches_objects_response_body_for_content_types
        • response_body_post_oneof_complex_types_response_body_for_content_types
        • response_body_post_oneof_response_body_for_content_types
        • response_body_post_oneof_with_base_schema_response_body_for_content_types
        • response_body_post_oneof_with_empty_schema_response_body_for_content_types
        • response_body_post_oneof_with_required_response_body_for_content_types
        • response_body_post_pattern_is_not_anchored_response_body_for_content_types
        • response_body_post_pattern_validation_response_body_for_content_types
        • response_body_post_properties_with_escaped_characters_response_body_for_content_types
        • response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types
        • response_body_post_ref_in_additionalproperties_response_body_for_content_types
        • response_body_post_ref_in_allof_response_body_for_content_types
        • response_body_post_ref_in_anyof_response_body_for_content_types
        • response_body_post_ref_in_items_response_body_for_content_types
        • response_body_post_ref_in_not_response_body_for_content_types
        • response_body_post_ref_in_oneof_response_body_for_content_types
        • response_body_post_ref_in_property_response_body_for_content_types
        • response_body_post_required_default_validation_response_body_for_content_types
        • response_body_post_required_validation_response_body_for_content_types
        • response_body_post_required_with_empty_array_response_body_for_content_types
        • response_body_post_required_with_escaped_characters_response_body_for_content_types
        • response_body_post_simple_enum_validation_response_body_for_content_types
        • response_body_post_string_type_matches_strings_response_body_for_content_types
        • response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types
        • response_body_post_uniqueitems_false_validation_response_body_for_content_types
        • response_body_post_uniqueitems_validation_response_body_for_content_types
        • response_body_post_uri_format_response_body_for_content_types
        • response_body_post_uri_reference_format_response_body_for_content_types
        • response_body_post_uri_template_format_response_body_for_content_types
      • src/unit_test_api/configurations
    • features
    • petstore/python

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

248 files changed

+841
-681
lines changed

‎modules/openapi-json-schema-generator/src/main/resources/python/configurations/api_configuration.hbs

+30-18
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,17 @@ SecuritySchemeInfo = typing_extensions.TypedDict(
5757
total=False
5858
)
5959

60-
"""
61-
the default security_index to use at each openapi document json path
62-
the fallback value is stored in the 'security' key
63-
"""
64-
SecurityIndexInfo = typing_extensions.TypedDict(
65-
'SecurityIndexInfo',
66-
{
60+
61+
class SecurityIndexInfoRequired(typing_extensions.TypedDict):
6762
{{#if security}}
68-
'security': typing_extensions.Literal[{{#each security}}{{#unless @first}}, {{/unless}}{{@key}}{{/each}}],
63+
security: typing_extensions.Literal[{{#each security}}{{#unless @first}}, {{/unless}}{{@key}}{{/each}}]
6964
{{else}}
70-
'security': int,
65+
security: int
7166
{{/if}}
67+
68+
SecurityIndexInfoOptional = typing_extensions.TypedDict(
69+
'SecurityIndexInfoOptional',
70+
{
7271
{{#each paths}}
7372
{{#if operations}}
7473
{{#each operations}}
@@ -81,6 +80,13 @@ SecurityIndexInfo = typing_extensions.TypedDict(
8180
},
8281
total=False
8382
)
83+
84+
85+
class SecurityIndexInfo(SecurityIndexInfoRequired, SecurityIndexInfoOptional):
86+
"""
87+
the default security_index to use at each openapi document json path
88+
the fallback value is stored in the 'security' key
89+
"""
8490
{{/if}}
8591
{{#if hasServers}}
8692

@@ -111,18 +117,17 @@ ServerInfo = typing_extensions.TypedDict(
111117
total=False
112118
)
113119

114-
"""
115-
the default server_index to use at each openapi document json path
116-
the fallback value is stored in the 'servers' key
117-
"""
118-
ServerIndexInfo = typing_extensions.TypedDict(
119-
'ServerIndexInfo',
120-
{
120+
121+
class ServerIndexInfoRequired(typing_extensions.TypedDict):
121122
{{#if servers}}
122-
'servers': typing_extensions.Literal[{{#each servers}}{{#unless @first}}, {{/unless}}{{@key}}{{/each}}],
123+
servers: typing_extensions.Literal[{{#each servers}}{{#unless @first}}, {{/unless}}{{@key}}{{/each}}]
123124
{{else}}
124-
'servers': int,
125+
servers: int
125126
{{/if}}
127+
128+
ServerIndexInfoOptional = typing_extensions.TypedDict(
129+
'ServerIndexInfoOptional',
130+
{
126131
{{#each paths}}
127132
{{#if servers}}
128133
"paths/{{@key.original}}/servers": typing_extensions.Literal[{{#each servers}}{{#unless @first}}, {{/unless}}{{@key}}{{/each}}],
@@ -138,6 +143,13 @@ ServerIndexInfo = typing_extensions.TypedDict(
138143
},
139144
total=False
140145
)
146+
147+
148+
class ServerIndexInfo(ServerIndexInfoRequired, ServerIndexInfoOptional):
149+
"""
150+
the default server_index to use at each openapi document json path
151+
the fallback value is stored in the 'servers' key
152+
"""
141153
{{/if}}
142154

143155

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

+28-2
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,41 @@ from {{packageName}}.components.security_schemes import {{refInfo.refModule}}
3434
{{/gt}}
3535
{{/neq}}
3636
{{/neq}}
37+
{{#neq security null}}
38+
{{#gt security.size 1}}
39+
security_index_info: api_configuration.SecurityIndexInfo = {
40+
"security": 0, # default value
41+
{{#each security}}
42+
{{#unless @first}}# only set one {{/unless}}"paths/{{path.original}}/{{httpMethod.original}}/security": {{@key}},
43+
{{/each}}
44+
}
45+
{{/gt}}
46+
{{else}}
47+
{{#neq rootSecurity null}}
48+
{{#gt rootSecurity.size 1}}
49+
security_index_info: api_configuration.SecurityIndexInfo = {
50+
{{#each rootSecurity}}
51+
{{#unless @first}}# only set one {{/unless}}"security": {{@key}},
52+
{{/each}}
53+
}
54+
{{/gt}}
55+
{{/neq}}
56+
{{/neq}}
3757
used_configuration = api_configuration.ApiConfiguration(
3858
{{#neq security null}}
3959
{{#gt security.size 0}}
40-
security_scheme_info=security_scheme_info
60+
security_scheme_info=security_scheme_info,
61+
{{/gt}}
62+
{{#gt security.size 1}}
63+
security_index_info=security_index_info
4164
{{/gt}}
4265
{{else}}
4366
{{#neq rootSecurity null}}
4467
{{#gt rootSecurity.size 0}}
45-
security_scheme_info=security_scheme_info
68+
security_scheme_info=security_scheme_info,
69+
{{/gt}}
70+
{{#gt rootSecurity.size 1}}
71+
security_index_info=security_index_info
4672
{{/gt}}
4773
{{/neq}}
4874
{{/neq}}

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

+13-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,18 @@ content_type | str | optional, default is '{{@key.original}}' | Selects the sche
9191
{{#if produces}}
9292
accept_content_types | typing.Tuple[str] | default is ({{#each produces}}"{{{.}}}", {{/each}}) | Tells the server the content type(s) that are accepted by the client
9393
{{/if}}
94-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
94+
{{#neq security null}}
95+
{{#gt security.size 0}}
96+
security_index | typing.Optional[int] | default is None | Allows one to select a different [security](#security) definition. If not None, must be one of [{{#each security}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}}]
97+
{{/gt}}
98+
{{else}}
99+
{{#neq ../security null}}
100+
{{#gt ../security.size 0}}
101+
security_index | typing.Optional[int] | default is None | Allows one to select a different [security](#security) definition. If not None, must be one of [{{#each ../security}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}}]
102+
{{/gt}}
103+
{{/neq}}
104+
{{/neq}}
105+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers){{#if servers}}. If not None, must be one of [{{#each servers}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}}]{{else}}{{#if pathItem.servers}}. If not None, must be one of [{{#each pathItem.servers}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}}]{{else}}. If not None, must be one of [{{#each ../servers}}{{@key}}{{#unless @last}}, {{/unless}}{{/each}}]{{/if}}{{/if}}
95106
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
96107
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
97108
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -222,7 +233,7 @@ server_index | Class | Description
222233
{{/each}}
223234
{{else}}
224235
{{#each ../servers}}
225-
{{@key}} | [{{jsonPathPiece.camelCase}}](../../../servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description}}{{/if}}
236+
{{@key}} | [{{jsonPathPiece.camelCase}}](../../servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description}}{{/if}}
226237
{{/each}}
227238
{{/if}}
228239
{{/if}}

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_simple_types_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_base_schema_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

‎samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
2929
------------- | ------------- | ------------- | -------------
3030
[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | required |
3131
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
32-
server_index | typing.Optional[int] | default is None | Allows one to select a different server
32+
server_index | typing.Optional[int] | default is None | Allows one to select a different [server](#servers). If not None, must be one of [0]
3333
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
3434
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
3535
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
@@ -77,7 +77,7 @@ passing server_index in to the endpoint method.
7777

7878
server_index | Class | Description
7979
------------ | ----- | ------------
80-
0 | [Server0](../../../servers/server_0.md) |
80+
0 | [Server0](../../servers/server_0.md) |
8181

8282
## Code Sample
8383

0 commit comments

Comments
 (0)