diff --git a/modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/DefaultGenerator.java b/modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/DefaultGenerator.java index b78ace7e68a..04299a611c4 100644 --- a/modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/DefaultGenerator.java +++ b/modules/openapi-json-schema-generator/src/main/java/org/openapijsonschematools/codegen/DefaultGenerator.java @@ -463,32 +463,20 @@ private void generatePathItem(List files, CodegenKey pathKey, CodegenPathI generateXs(files, operationJsonPath, CodegenConstants.JSON_PATH_LOCATION_TYPE.OPERATION, CodegenConstants.APIS, endpointMap, true); // operation docs - Map templateToSuffix = config.jsonPathDocTemplateFiles().get(CodegenConstants.JSON_PATH_LOCATION_TYPE.OPERATION); - if (templateToSuffix != null) { - for (Map.Entry templateToSuffixEntry: templateToSuffix.entrySet()) { - String templateFile = templateToSuffixEntry.getKey(); - String suffix = templateToSuffixEntry.getValue(); - for (Map.Entry tagEntry: operation.tags.entrySet()) { - CodegenTag tag = tagEntry.getValue(); - Map endpointInfo = new HashMap<>(); - endpointInfo.put("operation", operation); - endpointInfo.put("httpMethod", httpMethod); - endpointInfo.put("path", pathKey); - endpointInfo.put("pathItem", pathItem); - endpointInfo.put("servers", servers); - endpointInfo.put("security", security); - endpointInfo.put("packageName", config.packageName()); - endpointInfo.put("apiPackage", config.apiPackage()); - endpointInfo.put("tag", tag); - endpointInfo.put("headerSize", "#"); - endpointInfo.put("complexTypePrefix", "../../../components/schema/"); - endpointInfo.put("identifierPieces", Collections.unmodifiableList(new ArrayList<>())); - endpointInfo.put("identifierToHeadingQty", new HashMap<>()); - String outputFilename = filenameFromRoot(Arrays.asList("docs", config.apiPackage(), "tags", tag.moduleName, operation.operationId.snakeCase + suffix)); - generateFile(endpointInfo, templateFile, outputFilename, files, true, CodegenConstants.APIS); - } - } - } + Map endpointInfo = new HashMap<>(); + endpointInfo.put("operation", operation); + endpointInfo.put("httpMethod", httpMethod); + endpointInfo.put("path", pathKey); + endpointInfo.put("pathItem", pathItem); + endpointInfo.put("servers", servers); + endpointInfo.put("security", security); + endpointInfo.put("packageName", config.packageName()); + endpointInfo.put("apiPackage", config.apiPackage()); + endpointInfo.put("headerSize", "#"); + endpointInfo.put("complexTypePrefix", "../../components/schema/"); + endpointInfo.put("identifierPieces", Collections.unmodifiableList(new ArrayList<>())); + endpointInfo.put("identifierToHeadingQty", new HashMap<>()); + generateXDocs(files, operationJsonPath, CodegenConstants.JSON_PATH_LOCATION_TYPE.OPERATION, CodegenConstants.APIS, endpointInfo, true); // paths.some_path.security.security_requirement_0.py if (operation.security != null) { @@ -1056,7 +1044,7 @@ void generateApis(List files, TreeMap paths) } HashMap>> tagToPathToOperations = new HashMap<>(); - HashMap> tagToOperationIdToOperation = new HashMap<>(); + HashMap>> tagToOperationIdToPathToOperation = new HashMap<>(); Map apiPathTemplates = config.jsonPathTemplateFiles().get(CodegenConstants.JSON_PATH_LOCATION_TYPE.API_PATH); for(Map.Entry entry: paths.entrySet()) { CodegenKey path = entry.getKey(); @@ -1085,16 +1073,18 @@ void generateApis(List files, TreeMap paths) } if (!tagToPathToOperations.containsKey(tag)) { tagToPathToOperations.put(tag, new HashMap<>()); - tagToOperationIdToOperation.put(tag, new TreeMap<>()); + tagToOperationIdToPathToOperation.put(tag, new TreeMap<>()); } HashMap> pathToOperations = tagToPathToOperations.get(tag); if (!pathToOperations.containsKey(path)) { pathToOperations.put(path, new ArrayList<>()); } pathToOperations.get(path).add(op); - TreeMap operationIdToOperation = tagToOperationIdToOperation.get(tag); - if (!operationIdToOperation.containsKey(op.operationId)) { - operationIdToOperation.put(op.operationId, op); + TreeMap> operationIdToPathToOperation = tagToOperationIdToPathToOperation.get(tag); + if (!operationIdToPathToOperation.containsKey(op.operationId)) { + HashMap pathToOperation = new HashMap<>(); + pathToOperation.put(path, op); + operationIdToPathToOperation.put(op.operationId, pathToOperation); } } } @@ -1152,9 +1142,9 @@ public int compare(CodegenKey e1, CodegenKey e2) { } } - TreeMap operationIdToOperation = new TreeMap<>(new OperationIdComparator()); - operationIdToOperation.putAll(tagToOperationIdToOperation.get(tag)); - apiData.put("operationIdToOperation", operationIdToOperation); + TreeMap> operationIdToPathToOperation = new TreeMap<>(new OperationIdComparator()); + operationIdToPathToOperation.putAll(tagToOperationIdToPathToOperation.get(tag)); + apiData.put("operationIdToPathToOperation", operationIdToPathToOperation); if (apiTagTemplates != null) { for (Map.Entry apiPathEntry: apiTagTemplates.entrySet()) { diff --git a/modules/openapi-json-schema-generator/src/main/resources/python/_helper_readme_common.hbs b/modules/openapi-json-schema-generator/src/main/resources/python/_helper_readme_common.hbs index 50cf77f1394..1d04c0095e3 100644 --- a/modules/openapi-json-schema-generator/src/main/resources/python/_helper_readme_common.hbs +++ b/modules/openapi-json-schema-generator/src/main/resources/python/_helper_readme_common.hbs @@ -43,7 +43,7 @@ HTTP request | Method | Description ------------ | ------ | ------------- {{#each paths}} {{#each operations}} -{{../@key.original}} **{{@key.original}}** | {{#each tags}}[{{className}}]({{apiDocPath}}{{moduleName}}.md).[{{operationId.snakeCase}}]({{apiDocPath}}{{moduleName}}/{{operationId.snakeCase}}.md) {{/each}} | {{#if summary}}{{summary}}{{/if}} +{{../@key.original}} **{{@key.original}}** | {{#each tags}}[{{className}}]({{apiDocPath}}{{moduleName}}.md).[{{operationId.snakeCase}}](docs/paths/{{../../@key.snakeCase}}/{{../@key.original}}.md) {{/each}} | {{#if summary}}{{summary}}{{/if}} {{/each}} {{/each}} {{/if}} diff --git a/modules/openapi-json-schema-generator/src/main/resources/python/apis/tags/api_doc.hbs b/modules/openapi-json-schema-generator/src/main/resources/python/apis/tags/api_doc.hbs index d654f780e06..42d4bd1ac53 100644 --- a/modules/openapi-json-schema-generator/src/main/resources/python/apis/tags/api_doc.hbs +++ b/modules/openapi-json-schema-generator/src/main/resources/python/apis/tags/api_doc.hbs @@ -16,8 +16,10 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -{{#each operationIdToOperation}} -[**{{@key.snakeCase}}**]({{tag.moduleName}}/{{operationId.snakeCase}}.md) | {{#if summary}}{{summary}}{{/if}} +{{#each operationIdToPathToOperation}} + {{#each this}} +[**{{../@key.snakeCase}}**](../../paths/{{@key.snakeCase}}/{{jsonPathPiece.original}}.md) | {{#if summary}}{{summary}}{{/if}} + {{/each}} {{/each}} [[Back to top]](#top) {{> _helper_footer_links readmePath="../../../" endpointsLink=true }} diff --git a/modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/operation_doc.hbs b/modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/operation_doc.hbs index 951101356c5..f87a35e5b51 100644 --- a/modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/operation_doc.hbs +++ b/modules/openapi-json-schema-generator/src/main/resources/python/paths/path/verb/operation_doc.hbs @@ -1,6 +1,14 @@ {{#with operation}} - -{{headerSize}} **{{{operationId.snakeCase}}}** +{{packageName}}.paths.{{path.snakeCase}}.operation +{{headerSize}} Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | + {{#each tags}} +| {{../operationId.snakeCase}} | [{{className}}](../../apis/tags/{{moduleName}}.md) | This api is only for tag={{{name}}} | + {{/each}} +| {{httpMethod.original}} | ApiFor{{httpMethod.camelCase}} | This api is only for this endpoint | +| {{httpMethod.original}} | {{path.camelCase}} | This api is only for path={{{path.original}}} | {{headerSize}}# Table of Contents - [General Info](#general-info) @@ -40,9 +48,9 @@ Name | Type | Description | Notes {{#if refInfo}} {{#with getDeepestRef}} {{#if required}} -[**body**](../../../components/request_bodies/{{../refInfo.refModule}}.md) | typing.Union[{{#each content}}{{#with this.schema}}[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.{{jsonPathPiece.snakeCase}}](../../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append identifierPieces "content" ../@key jsonPathPiece) }}){{/with}}, {{/each}}{{#each getContentSchemas}}{{> _helper_schema_python_types }}{{#unless @last}}, {{/unless}}{{/each}}] | required | +[**body**](../../components/request_bodies/{{../refInfo.refModule}}.md) | typing.Union[{{#each content}}{{#with this.schema}}[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.{{jsonPathPiece.snakeCase}}](../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append identifierPieces "content" ../@key jsonPathPiece) }}){{/with}}, {{/each}}{{#each getContentSchemas}}{{> _helper_schema_python_types }}{{#unless @last}}, {{/unless}}{{/each}}] | required | {{else}} -[**body**](../../../components/request_bodies/{{../refInfo.refModule}}.md) | typing.Union[{{#each content}}{{#with this.schema}}[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.{{jsonPathPiece.snakeCase}}](../../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append identifierPieces "content" ../@key jsonPathPiece) }}){{/with}}, {{/each}}Unset, {{#each getContentSchemas}}{{> _helper_schema_python_types }}{{#unless @last}}, {{/unless}}{{/each}}] | optional, default is unset | +[**body**](../../components/request_bodies/{{../refInfo.refModule}}.md) | typing.Union[{{#each content}}{{#with this.schema}}[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.{{jsonPathPiece.snakeCase}}](../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append identifierPieces "content" ../@key jsonPathPiece) }}){{/with}}, {{/each}}Unset, {{#each getContentSchemas}}{{> _helper_schema_python_types }}{{#unless @last}}, {{/unless}}{{/each}}] | optional, default is unset | {{/if}} {{/with}} {{else}} @@ -114,7 +122,7 @@ n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization i {{#if defaultResponse}} {{#with defaultResponse}} {{#if refInfo}} -default | [{{refInfo.refClass}}.response_cls](../../../components/responses/{{refInfo.refModule}}.md#{{refInfo.refModule}}response_cls) | {{#with getDeepestRef}}{{description}}{{/with}} +default | [{{refInfo.refClass}}.response_cls](../../components/responses/{{refInfo.refModule}}.md#{{refInfo.refModule}}response_cls) | {{#with getDeepestRef}}{{description}}{{/with}} {{else}} default | [{{jsonPathPiece.camelCase}}.response_cls](#{{jsonPathPiece.anchorPiece}}-response_cls) | {{description}} {{/if}} @@ -122,7 +130,7 @@ default | [{{jsonPathPiece.camelCase}}.response_cls](#{{jsonPathPiece.anchorPiec {{/if}} {{#each nonDefaultResponses}} {{#if refInfo}} -{{@key}} | [{{refInfo.refClass}}.response_cls](../../../components/responses/{{refInfo.refModule}}.md#{{refInfo.refModule}}response_cls) | {{#with getDeepestRef}}{{description}}{{/with}} +{{@key}} | [{{refInfo.refClass}}.response_cls](../../components/responses/{{refInfo.refModule}}.md#{{refInfo.refModule}}response_cls) | {{#with getDeepestRef}}{{description}}{{/with}} {{else}} {{@key}} | [{{jsonPathPiece.camelCase}}.response_cls](#{{jsonPathPiece.anchorPiece}}-response_cls) | {{description}} {{/if}} @@ -149,7 +157,7 @@ See how to do this in the code sample. | Security Index | Security Scheme to Scope Names | | -------------- | ------------------------------ | {{#each security}} -| {{@key}} | {{#eq this.size 0}}no security{{else}}{{#each this}}["{{{@key}}}"](../../../components/security_schemes/{{this.refInfo.refModule}}.md) {{this.scopeNames}}
{{/each}}{{/eq}} | +| {{@key}} | {{#eq this.size 0}}no security{{else}}{{#each this}}["{{{@key}}}"](../../components/security_schemes/{{this.refInfo.refModule}}.md) {{this.scopeNames}}
{{/each}}{{/eq}} | {{/each}} {{/gt}} {{else}} @@ -169,7 +177,7 @@ See how to do this in the code sample. | Security Index | Security Scheme to Scope Names | | -------------- | ------------------------------ | {{#each ../security}} -| {{@key}} | {{#eq this.size 0}}no security{{else}}{{#each this}}["{{{@key}}}"](../../../components/security_schemes/{{this.refInfo.refModule}}.md) {{this.scopeNames}}
{{/each}}{{/eq}} | +| {{@key}} | {{#eq this.size 0}}no security{{else}}{{#each this}}["{{{@key}}}"](../../components/security_schemes/{{this.refInfo.refModule}}.md) {{this.scopeNames}}
{{/each}}{{/eq}} | {{/each}} {{/gt}} {{/neq}} @@ -236,5 +244,9 @@ server_index | Class | Description {{> paths/path/verb/_helper_operation_doc_example rootSecurity=../security }} -[[Back to top]](#top) [[Back to API]](../{{tag.moduleName}}.md) {{> _helper_footer_links readmePath="../../../../" endpointsLink=true}} +[[Back to top]](#top) + {{#each tags}} +[[Back to {{className}} API]](../../apis/tags/{{moduleName}}.md) + {{/each}} +{{> _helper_footer_links readmePath="../../../" endpointsLink=true}} {{/with}} \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/.openapi-generator/FILES b/samples/openapi3/client/3_0_3_unit_test/python/.openapi-generator/FILES index 78994899363..39a7466790c 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/.openapi-generator/FILES +++ b/samples/openapi3/client/3_0_3_unit_test/python/.openapi-generator/FILES @@ -3,729 +3,33 @@ .travis.yml README.md docs/apis/tags/_not_api.md -docs/apis/tags/_not_api/post_forbidden_property_request_body.md -docs/apis/tags/_not_api/post_forbidden_property_response_body_for_content_types.md -docs/apis/tags/_not_api/post_not_more_complex_schema_request_body.md -docs/apis/tags/_not_api/post_not_more_complex_schema_response_body_for_content_types.md -docs/apis/tags/_not_api/post_not_request_body.md -docs/apis/tags/_not_api/post_not_response_body_for_content_types.md docs/apis/tags/additional_properties_api.md -docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md -docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md -docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md -docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md -docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md -docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md -docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md -docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md docs/apis/tags/all_of_api.md -docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_request_body.md -docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_request_body.md -docs/apis/tags/all_of_api/post_allof_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_simple_types_request_body.md -docs/apis/tags/all_of_api/post_allof_simple_types_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_with_base_schema_request_body.md -docs/apis/tags/all_of_api/post_allof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_request_body.md -docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_request_body.md -docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_request_body.md -docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_request_body.md -docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md -docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md -docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md docs/apis/tags/any_of_api.md -docs/apis/tags/any_of_api/post_anyof_complex_types_request_body.md -docs/apis/tags/any_of_api/post_anyof_complex_types_response_body_for_content_types.md -docs/apis/tags/any_of_api/post_anyof_request_body.md -docs/apis/tags/any_of_api/post_anyof_response_body_for_content_types.md -docs/apis/tags/any_of_api/post_anyof_with_base_schema_request_body.md -docs/apis/tags/any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_request_body.md -docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md -docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md docs/apis/tags/content_type_json_api.md -docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md -docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md -docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md -docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md -docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md -docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_request_body.md -docs/apis/tags/content_type_json_api/post_allof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_simple_types_request_body.md -docs/apis/tags/content_type_json_api/post_allof_simple_types_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_with_base_schema_request_body.md -docs/apis/tags/content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_request_body.md -docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md -docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md -docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_request_body.md -docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_anyof_complex_types_request_body.md -docs/apis/tags/content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_anyof_request_body.md -docs/apis/tags/content_type_json_api/post_anyof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_request_body.md -docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_request_body.md -docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_request_body.md -docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_request_body.md -docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_by_int_request_body.md -docs/apis/tags/content_type_json_api/post_by_int_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_by_number_request_body.md -docs/apis/tags/content_type_json_api/post_by_number_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_by_small_number_request_body.md -docs/apis/tags/content_type_json_api/post_by_small_number_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_date_time_format_request_body.md -docs/apis/tags/content_type_json_api/post_date_time_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_email_format_request_body.md -docs/apis/tags/content_type_json_api/post_email_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_request_body.md -docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_request_body.md -docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_request_body.md -docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_request_body.md -docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_request_body.md -docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_enums_in_properties_request_body.md -docs/apis/tags/content_type_json_api/post_enums_in_properties_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_forbidden_property_request_body.md -docs/apis/tags/content_type_json_api/post_forbidden_property_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_hostname_format_request_body.md -docs/apis/tags/content_type_json_api/post_hostname_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_request_body.md -docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md -docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_request_body.md -docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ipv4_format_request_body.md -docs/apis/tags/content_type_json_api/post_ipv4_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ipv6_format_request_body.md -docs/apis/tags/content_type_json_api/post_ipv6_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_json_pointer_format_request_body.md -docs/apis/tags/content_type_json_api/post_json_pointer_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maximum_validation_request_body.md -docs/apis/tags/content_type_json_api/post_maximum_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md -docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maxitems_validation_request_body.md -docs/apis/tags/content_type_json_api/post_maxitems_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maxlength_validation_request_body.md -docs/apis/tags/content_type_json_api/post_maxlength_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md -docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_maxproperties_validation_request_body.md -docs/apis/tags/content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_minimum_validation_request_body.md -docs/apis/tags/content_type_json_api/post_minimum_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md -docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_minitems_validation_request_body.md -docs/apis/tags/content_type_json_api/post_minitems_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_minlength_validation_request_body.md -docs/apis/tags/content_type_json_api/post_minlength_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_minproperties_validation_request_body.md -docs/apis/tags/content_type_json_api/post_minproperties_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md -docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md -docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_nested_items_request_body.md -docs/apis/tags/content_type_json_api/post_nested_items_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md -docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_not_more_complex_schema_request_body.md -docs/apis/tags/content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_not_request_body.md -docs/apis/tags/content_type_json_api/post_not_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_request_body.md -docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md -docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_request_body.md -docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_object_properties_validation_request_body.md -docs/apis/tags/content_type_json_api/post_object_properties_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_object_type_matches_objects_request_body.md -docs/apis/tags/content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_oneof_complex_types_request_body.md -docs/apis/tags/content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_oneof_request_body.md -docs/apis/tags/content_type_json_api/post_oneof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_request_body.md -docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_request_body.md -docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_oneof_with_required_request_body.md -docs/apis/tags/content_type_json_api/post_oneof_with_required_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_request_body.md -docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_pattern_validation_request_body.md -docs/apis/tags/content_type_json_api/post_pattern_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_request_body.md -docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md -docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_allof_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_allof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_anyof_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_items_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_items_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_not_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_not_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_oneof_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_ref_in_property_request_body.md -docs/apis/tags/content_type_json_api/post_ref_in_property_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_required_default_validation_request_body.md -docs/apis/tags/content_type_json_api/post_required_default_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_required_validation_request_body.md -docs/apis/tags/content_type_json_api/post_required_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_required_with_empty_array_request_body.md -docs/apis/tags/content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_request_body.md -docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_simple_enum_validation_request_body.md -docs/apis/tags/content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_string_type_matches_strings_request_body.md -docs/apis/tags/content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md -docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_request_body.md -docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_uniqueitems_validation_request_body.md -docs/apis/tags/content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_uri_format_request_body.md -docs/apis/tags/content_type_json_api/post_uri_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_uri_reference_format_request_body.md -docs/apis/tags/content_type_json_api/post_uri_reference_format_response_body_for_content_types.md -docs/apis/tags/content_type_json_api/post_uri_template_format_request_body.md -docs/apis/tags/content_type_json_api/post_uri_template_format_response_body_for_content_types.md docs/apis/tags/default_api.md -docs/apis/tags/default_api/post_invalid_string_value_for_default_request_body.md -docs/apis/tags/default_api/post_invalid_string_value_for_default_response_body_for_content_types.md -docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md -docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md docs/apis/tags/enum_api.md -docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_request_body.md -docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md -docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_request_body.md -docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md -docs/apis/tags/enum_api/post_enum_with_escaped_characters_request_body.md -docs/apis/tags/enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_request_body.md -docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md -docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_request_body.md -docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md -docs/apis/tags/enum_api/post_enums_in_properties_request_body.md -docs/apis/tags/enum_api/post_enums_in_properties_response_body_for_content_types.md -docs/apis/tags/enum_api/post_nul_characters_in_strings_request_body.md -docs/apis/tags/enum_api/post_nul_characters_in_strings_response_body_for_content_types.md -docs/apis/tags/enum_api/post_simple_enum_validation_request_body.md -docs/apis/tags/enum_api/post_simple_enum_validation_response_body_for_content_types.md docs/apis/tags/format_api.md -docs/apis/tags/format_api/post_date_time_format_request_body.md -docs/apis/tags/format_api/post_date_time_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_email_format_request_body.md -docs/apis/tags/format_api/post_email_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_hostname_format_request_body.md -docs/apis/tags/format_api/post_hostname_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_ipv4_format_request_body.md -docs/apis/tags/format_api/post_ipv4_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_ipv6_format_request_body.md -docs/apis/tags/format_api/post_ipv6_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_json_pointer_format_request_body.md -docs/apis/tags/format_api/post_json_pointer_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_uri_format_request_body.md -docs/apis/tags/format_api/post_uri_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_uri_reference_format_request_body.md -docs/apis/tags/format_api/post_uri_reference_format_response_body_for_content_types.md -docs/apis/tags/format_api/post_uri_template_format_request_body.md -docs/apis/tags/format_api/post_uri_template_format_response_body_for_content_types.md docs/apis/tags/items_api.md -docs/apis/tags/items_api/post_nested_items_request_body.md -docs/apis/tags/items_api/post_nested_items_response_body_for_content_types.md docs/apis/tags/max_items_api.md -docs/apis/tags/max_items_api/post_maxitems_validation_request_body.md -docs/apis/tags/max_items_api/post_maxitems_validation_response_body_for_content_types.md docs/apis/tags/max_length_api.md -docs/apis/tags/max_length_api/post_maxlength_validation_request_body.md -docs/apis/tags/max_length_api/post_maxlength_validation_response_body_for_content_types.md docs/apis/tags/max_properties_api.md -docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md -docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md -docs/apis/tags/max_properties_api/post_maxproperties_validation_request_body.md -docs/apis/tags/max_properties_api/post_maxproperties_validation_response_body_for_content_types.md docs/apis/tags/maximum_api.md -docs/apis/tags/maximum_api/post_maximum_validation_request_body.md -docs/apis/tags/maximum_api/post_maximum_validation_response_body_for_content_types.md -docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md -docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md docs/apis/tags/min_items_api.md -docs/apis/tags/min_items_api/post_minitems_validation_request_body.md -docs/apis/tags/min_items_api/post_minitems_validation_response_body_for_content_types.md docs/apis/tags/min_length_api.md -docs/apis/tags/min_length_api/post_minlength_validation_request_body.md -docs/apis/tags/min_length_api/post_minlength_validation_response_body_for_content_types.md docs/apis/tags/min_properties_api.md -docs/apis/tags/min_properties_api/post_minproperties_validation_request_body.md -docs/apis/tags/min_properties_api/post_minproperties_validation_response_body_for_content_types.md docs/apis/tags/minimum_api.md -docs/apis/tags/minimum_api/post_minimum_validation_request_body.md -docs/apis/tags/minimum_api/post_minimum_validation_response_body_for_content_types.md -docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_request_body.md -docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md docs/apis/tags/multiple_of_api.md -docs/apis/tags/multiple_of_api/post_by_int_request_body.md -docs/apis/tags/multiple_of_api/post_by_int_response_body_for_content_types.md -docs/apis/tags/multiple_of_api/post_by_number_request_body.md -docs/apis/tags/multiple_of_api/post_by_number_response_body_for_content_types.md -docs/apis/tags/multiple_of_api/post_by_small_number_request_body.md -docs/apis/tags/multiple_of_api/post_by_small_number_response_body_for_content_types.md -docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md -docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md docs/apis/tags/one_of_api.md -docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md -docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/one_of_api/post_oneof_complex_types_request_body.md -docs/apis/tags/one_of_api/post_oneof_complex_types_response_body_for_content_types.md -docs/apis/tags/one_of_api/post_oneof_request_body.md -docs/apis/tags/one_of_api/post_oneof_response_body_for_content_types.md -docs/apis/tags/one_of_api/post_oneof_with_base_schema_request_body.md -docs/apis/tags/one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/one_of_api/post_oneof_with_empty_schema_request_body.md -docs/apis/tags/one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md -docs/apis/tags/one_of_api/post_oneof_with_required_request_body.md -docs/apis/tags/one_of_api/post_oneof_with_required_response_body_for_content_types.md docs/apis/tags/operation_request_body_api.md -docs/apis/tags/operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md -docs/apis/tags/operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md -docs/apis/tags/operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md -docs/apis/tags/operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_simple_types_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_with_base_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_with_one_empty_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md -docs/apis/tags/operation_request_body_api/post_anyof_complex_types_request_body.md -docs/apis/tags/operation_request_body_api/post_anyof_request_body.md -docs/apis/tags/operation_request_body_api/post_anyof_with_base_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_array_type_matches_arrays_request_body.md -docs/apis/tags/operation_request_body_api/post_boolean_type_matches_booleans_request_body.md -docs/apis/tags/operation_request_body_api/post_by_int_request_body.md -docs/apis/tags/operation_request_body_api/post_by_number_request_body.md -docs/apis/tags/operation_request_body_api/post_by_small_number_request_body.md -docs/apis/tags/operation_request_body_api/post_date_time_format_request_body.md -docs/apis/tags/operation_request_body_api/post_email_format_request_body.md -docs/apis/tags/operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md -docs/apis/tags/operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md -docs/apis/tags/operation_request_body_api/post_enum_with_escaped_characters_request_body.md -docs/apis/tags/operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md -docs/apis/tags/operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md -docs/apis/tags/operation_request_body_api/post_enums_in_properties_request_body.md -docs/apis/tags/operation_request_body_api/post_forbidden_property_request_body.md -docs/apis/tags/operation_request_body_api/post_hostname_format_request_body.md -docs/apis/tags/operation_request_body_api/post_integer_type_matches_integers_request_body.md -docs/apis/tags/operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md -docs/apis/tags/operation_request_body_api/post_invalid_string_value_for_default_request_body.md -docs/apis/tags/operation_request_body_api/post_ipv4_format_request_body.md -docs/apis/tags/operation_request_body_api/post_ipv6_format_request_body.md -docs/apis/tags/operation_request_body_api/post_json_pointer_format_request_body.md -docs/apis/tags/operation_request_body_api/post_maximum_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md -docs/apis/tags/operation_request_body_api/post_maxitems_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_maxlength_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md -docs/apis/tags/operation_request_body_api/post_maxproperties_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_minimum_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md -docs/apis/tags/operation_request_body_api/post_minitems_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_minlength_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_minproperties_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md -docs/apis/tags/operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md -docs/apis/tags/operation_request_body_api/post_nested_items_request_body.md -docs/apis/tags/operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md -docs/apis/tags/operation_request_body_api/post_not_more_complex_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_not_request_body.md -docs/apis/tags/operation_request_body_api/post_nul_characters_in_strings_request_body.md -docs/apis/tags/operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md -docs/apis/tags/operation_request_body_api/post_number_type_matches_numbers_request_body.md -docs/apis/tags/operation_request_body_api/post_object_properties_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_object_type_matches_objects_request_body.md -docs/apis/tags/operation_request_body_api/post_oneof_complex_types_request_body.md -docs/apis/tags/operation_request_body_api/post_oneof_request_body.md -docs/apis/tags/operation_request_body_api/post_oneof_with_base_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_oneof_with_empty_schema_request_body.md -docs/apis/tags/operation_request_body_api/post_oneof_with_required_request_body.md -docs/apis/tags/operation_request_body_api/post_pattern_is_not_anchored_request_body.md -docs/apis/tags/operation_request_body_api/post_pattern_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_properties_with_escaped_characters_request_body.md -docs/apis/tags/operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_additionalproperties_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_allof_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_anyof_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_items_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_not_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_oneof_request_body.md -docs/apis/tags/operation_request_body_api/post_ref_in_property_request_body.md -docs/apis/tags/operation_request_body_api/post_required_default_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_required_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_required_with_empty_array_request_body.md -docs/apis/tags/operation_request_body_api/post_required_with_escaped_characters_request_body.md -docs/apis/tags/operation_request_body_api/post_simple_enum_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_string_type_matches_strings_request_body.md -docs/apis/tags/operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md -docs/apis/tags/operation_request_body_api/post_uniqueitems_false_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_uniqueitems_validation_request_body.md -docs/apis/tags/operation_request_body_api/post_uri_format_request_body.md -docs/apis/tags/operation_request_body_api/post_uri_reference_format_request_body.md -docs/apis/tags/operation_request_body_api/post_uri_template_format_request_body.md docs/apis/tags/path_post_api.md -docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md -docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md -docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md -docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md -docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_request_body.md -docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_request_body.md -docs/apis/tags/path_post_api/post_allof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_simple_types_request_body.md -docs/apis/tags/path_post_api/post_allof_simple_types_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_with_base_schema_request_body.md -docs/apis/tags/path_post_api/post_allof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_request_body.md -docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_request_body.md -docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_request_body.md -docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_request_body.md -docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_anyof_complex_types_request_body.md -docs/apis/tags/path_post_api/post_anyof_complex_types_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_anyof_request_body.md -docs/apis/tags/path_post_api/post_anyof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_anyof_with_base_schema_request_body.md -docs/apis/tags/path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_request_body.md -docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_array_type_matches_arrays_request_body.md -docs/apis/tags/path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_request_body.md -docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_by_int_request_body.md -docs/apis/tags/path_post_api/post_by_int_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_by_number_request_body.md -docs/apis/tags/path_post_api/post_by_number_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_by_small_number_request_body.md -docs/apis/tags/path_post_api/post_by_small_number_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_date_time_format_request_body.md -docs/apis/tags/path_post_api/post_date_time_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_email_format_request_body.md -docs/apis/tags/path_post_api/post_email_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_request_body.md -docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_request_body.md -docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enum_with_escaped_characters_request_body.md -docs/apis/tags/path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_request_body.md -docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_request_body.md -docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_enums_in_properties_request_body.md -docs/apis/tags/path_post_api/post_enums_in_properties_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_forbidden_property_request_body.md -docs/apis/tags/path_post_api/post_forbidden_property_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_hostname_format_request_body.md -docs/apis/tags/path_post_api/post_hostname_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_integer_type_matches_integers_request_body.md -docs/apis/tags/path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md -docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_invalid_string_value_for_default_request_body.md -docs/apis/tags/path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ipv4_format_request_body.md -docs/apis/tags/path_post_api/post_ipv4_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ipv6_format_request_body.md -docs/apis/tags/path_post_api/post_ipv6_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_json_pointer_format_request_body.md -docs/apis/tags/path_post_api/post_json_pointer_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maximum_validation_request_body.md -docs/apis/tags/path_post_api/post_maximum_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md -docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maxitems_validation_request_body.md -docs/apis/tags/path_post_api/post_maxitems_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maxlength_validation_request_body.md -docs/apis/tags/path_post_api/post_maxlength_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md -docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_maxproperties_validation_request_body.md -docs/apis/tags/path_post_api/post_maxproperties_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_minimum_validation_request_body.md -docs/apis/tags/path_post_api/post_minimum_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_request_body.md -docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_minitems_validation_request_body.md -docs/apis/tags/path_post_api/post_minitems_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_minlength_validation_request_body.md -docs/apis/tags/path_post_api/post_minlength_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_minproperties_validation_request_body.md -docs/apis/tags/path_post_api/post_minproperties_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md -docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md -docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_nested_items_request_body.md -docs/apis/tags/path_post_api/post_nested_items_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md -docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_not_more_complex_schema_request_body.md -docs/apis/tags/path_post_api/post_not_more_complex_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_not_request_body.md -docs/apis/tags/path_post_api/post_not_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_nul_characters_in_strings_request_body.md -docs/apis/tags/path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_request_body.md -docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_number_type_matches_numbers_request_body.md -docs/apis/tags/path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_object_properties_validation_request_body.md -docs/apis/tags/path_post_api/post_object_properties_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_object_type_matches_objects_request_body.md -docs/apis/tags/path_post_api/post_object_type_matches_objects_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_oneof_complex_types_request_body.md -docs/apis/tags/path_post_api/post_oneof_complex_types_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_oneof_request_body.md -docs/apis/tags/path_post_api/post_oneof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_oneof_with_base_schema_request_body.md -docs/apis/tags/path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_oneof_with_empty_schema_request_body.md -docs/apis/tags/path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_oneof_with_required_request_body.md -docs/apis/tags/path_post_api/post_oneof_with_required_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_pattern_is_not_anchored_request_body.md -docs/apis/tags/path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_pattern_validation_request_body.md -docs/apis/tags/path_post_api/post_pattern_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_properties_with_escaped_characters_request_body.md -docs/apis/tags/path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md -docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_additionalproperties_request_body.md -docs/apis/tags/path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_allof_request_body.md -docs/apis/tags/path_post_api/post_ref_in_allof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_anyof_request_body.md -docs/apis/tags/path_post_api/post_ref_in_anyof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_items_request_body.md -docs/apis/tags/path_post_api/post_ref_in_items_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_not_request_body.md -docs/apis/tags/path_post_api/post_ref_in_not_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_oneof_request_body.md -docs/apis/tags/path_post_api/post_ref_in_oneof_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_ref_in_property_request_body.md -docs/apis/tags/path_post_api/post_ref_in_property_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_required_default_validation_request_body.md -docs/apis/tags/path_post_api/post_required_default_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_required_validation_request_body.md -docs/apis/tags/path_post_api/post_required_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_required_with_empty_array_request_body.md -docs/apis/tags/path_post_api/post_required_with_empty_array_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_required_with_escaped_characters_request_body.md -docs/apis/tags/path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_simple_enum_validation_request_body.md -docs/apis/tags/path_post_api/post_simple_enum_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_string_type_matches_strings_request_body.md -docs/apis/tags/path_post_api/post_string_type_matches_strings_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md -docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_uniqueitems_false_validation_request_body.md -docs/apis/tags/path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_uniqueitems_validation_request_body.md -docs/apis/tags/path_post_api/post_uniqueitems_validation_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_uri_format_request_body.md -docs/apis/tags/path_post_api/post_uri_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_uri_reference_format_request_body.md -docs/apis/tags/path_post_api/post_uri_reference_format_response_body_for_content_types.md -docs/apis/tags/path_post_api/post_uri_template_format_request_body.md -docs/apis/tags/path_post_api/post_uri_template_format_response_body_for_content_types.md docs/apis/tags/pattern_api.md -docs/apis/tags/pattern_api/post_pattern_is_not_anchored_request_body.md -docs/apis/tags/pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md -docs/apis/tags/pattern_api/post_pattern_validation_request_body.md -docs/apis/tags/pattern_api/post_pattern_validation_response_body_for_content_types.md docs/apis/tags/properties_api.md -docs/apis/tags/properties_api/post_object_properties_validation_request_body.md -docs/apis/tags/properties_api/post_object_properties_validation_response_body_for_content_types.md -docs/apis/tags/properties_api/post_properties_with_escaped_characters_request_body.md -docs/apis/tags/properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md docs/apis/tags/ref_api.md -docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md -docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_additionalproperties_request_body.md -docs/apis/tags/ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_allof_request_body.md -docs/apis/tags/ref_api/post_ref_in_allof_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_anyof_request_body.md -docs/apis/tags/ref_api/post_ref_in_anyof_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_items_request_body.md -docs/apis/tags/ref_api/post_ref_in_items_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_not_request_body.md -docs/apis/tags/ref_api/post_ref_in_not_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_oneof_request_body.md -docs/apis/tags/ref_api/post_ref_in_oneof_response_body_for_content_types.md -docs/apis/tags/ref_api/post_ref_in_property_request_body.md -docs/apis/tags/ref_api/post_ref_in_property_response_body_for_content_types.md docs/apis/tags/required_api.md -docs/apis/tags/required_api/post_required_default_validation_request_body.md -docs/apis/tags/required_api/post_required_default_validation_response_body_for_content_types.md -docs/apis/tags/required_api/post_required_validation_request_body.md -docs/apis/tags/required_api/post_required_validation_response_body_for_content_types.md -docs/apis/tags/required_api/post_required_with_empty_array_request_body.md -docs/apis/tags/required_api/post_required_with_empty_array_response_body_for_content_types.md -docs/apis/tags/required_api/post_required_with_escaped_characters_request_body.md -docs/apis/tags/required_api/post_required_with_escaped_characters_response_body_for_content_types.md docs/apis/tags/response_content_content_type_schema_api.md -docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_not_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md -docs/apis/tags/response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md docs/apis/tags/type_api.md -docs/apis/tags/type_api/post_array_type_matches_arrays_request_body.md -docs/apis/tags/type_api/post_array_type_matches_arrays_response_body_for_content_types.md -docs/apis/tags/type_api/post_boolean_type_matches_booleans_request_body.md -docs/apis/tags/type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md -docs/apis/tags/type_api/post_integer_type_matches_integers_request_body.md -docs/apis/tags/type_api/post_integer_type_matches_integers_response_body_for_content_types.md -docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_request_body.md -docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md -docs/apis/tags/type_api/post_number_type_matches_numbers_request_body.md -docs/apis/tags/type_api/post_number_type_matches_numbers_response_body_for_content_types.md -docs/apis/tags/type_api/post_object_type_matches_objects_request_body.md -docs/apis/tags/type_api/post_object_type_matches_objects_response_body_for_content_types.md -docs/apis/tags/type_api/post_string_type_matches_strings_request_body.md -docs/apis/tags/type_api/post_string_type_matches_strings_response_body_for_content_types.md docs/apis/tags/unique_items_api.md -docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_request_body.md -docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md -docs/apis/tags/unique_items_api/post_uniqueitems_validation_request_body.md -docs/apis/tags/unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md docs/components/schema/_not.md docs/components/schema/additionalproperties_allows_a_schema_which_should_validate.md docs/components/schema/additionalproperties_are_allowed_by_default.md @@ -813,6 +117,180 @@ docs/components/schema/uniqueitems_validation.md docs/components/schema/uri_format.md docs/components/schema/uri_reference_format.md docs/components/schema/uri_template_format.md +docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md +docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md +docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md +docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md +docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md +docs/paths/request_body_post_allof_request_body/post.md +docs/paths/request_body_post_allof_simple_types_request_body/post.md +docs/paths/request_body_post_allof_with_base_schema_request_body/post.md +docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md +docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md +docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md +docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md +docs/paths/request_body_post_anyof_complex_types_request_body/post.md +docs/paths/request_body_post_anyof_request_body/post.md +docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md +docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md +docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md +docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md +docs/paths/request_body_post_by_int_request_body/post.md +docs/paths/request_body_post_by_number_request_body/post.md +docs/paths/request_body_post_by_small_number_request_body/post.md +docs/paths/request_body_post_date_time_format_request_body/post.md +docs/paths/request_body_post_email_format_request_body/post.md +docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md +docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md +docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md +docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md +docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md +docs/paths/request_body_post_enums_in_properties_request_body/post.md +docs/paths/request_body_post_forbidden_property_request_body/post.md +docs/paths/request_body_post_hostname_format_request_body/post.md +docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md +docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md +docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md +docs/paths/request_body_post_ipv4_format_request_body/post.md +docs/paths/request_body_post_ipv6_format_request_body/post.md +docs/paths/request_body_post_json_pointer_format_request_body/post.md +docs/paths/request_body_post_maximum_validation_request_body/post.md +docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md +docs/paths/request_body_post_maxitems_validation_request_body/post.md +docs/paths/request_body_post_maxlength_validation_request_body/post.md +docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md +docs/paths/request_body_post_maxproperties_validation_request_body/post.md +docs/paths/request_body_post_minimum_validation_request_body/post.md +docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md +docs/paths/request_body_post_minitems_validation_request_body/post.md +docs/paths/request_body_post_minlength_validation_request_body/post.md +docs/paths/request_body_post_minproperties_validation_request_body/post.md +docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md +docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md +docs/paths/request_body_post_nested_items_request_body/post.md +docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md +docs/paths/request_body_post_not_more_complex_schema_request_body/post.md +docs/paths/request_body_post_not_request_body/post.md +docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md +docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md +docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md +docs/paths/request_body_post_object_properties_validation_request_body/post.md +docs/paths/request_body_post_object_type_matches_objects_request_body/post.md +docs/paths/request_body_post_oneof_complex_types_request_body/post.md +docs/paths/request_body_post_oneof_request_body/post.md +docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md +docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md +docs/paths/request_body_post_oneof_with_required_request_body/post.md +docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md +docs/paths/request_body_post_pattern_validation_request_body/post.md +docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md +docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md +docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md +docs/paths/request_body_post_ref_in_allof_request_body/post.md +docs/paths/request_body_post_ref_in_anyof_request_body/post.md +docs/paths/request_body_post_ref_in_items_request_body/post.md +docs/paths/request_body_post_ref_in_not_request_body/post.md +docs/paths/request_body_post_ref_in_oneof_request_body/post.md +docs/paths/request_body_post_ref_in_property_request_body/post.md +docs/paths/request_body_post_required_default_validation_request_body/post.md +docs/paths/request_body_post_required_validation_request_body/post.md +docs/paths/request_body_post_required_with_empty_array_request_body/post.md +docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md +docs/paths/request_body_post_simple_enum_validation_request_body/post.md +docs/paths/request_body_post_string_type_matches_strings_request_body/post.md +docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md +docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md +docs/paths/request_body_post_uniqueitems_validation_request_body/post.md +docs/paths/request_body_post_uri_format_request_body/post.md +docs/paths/request_body_post_uri_reference_format_request_body/post.md +docs/paths/request_body_post_uri_template_format_request_body/post.md +docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md +docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md +docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md +docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md +docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md +docs/paths/response_body_post_anyof_response_body_for_content_types/post.md +docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md +docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md +docs/paths/response_body_post_by_int_response_body_for_content_types/post.md +docs/paths/response_body_post_by_number_response_body_for_content_types/post.md +docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md +docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md +docs/paths/response_body_post_email_format_response_body_for_content_types/post.md +docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md +docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md +docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md +docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md +docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md +docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md +docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md +docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md +docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md +docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md +docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md +docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md +docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md +docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md +docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md +docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md +docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md +docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md +docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md +docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md +docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md +docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_not_response_body_for_content_types/post.md +docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md +docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md +docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md +docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md +docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md +docs/paths/response_body_post_oneof_response_body_for_content_types/post.md +docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md +docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md +docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md +docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md +docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md +docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md +docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md +docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md +docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md +docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md +docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md +docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md +docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md +docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md docs/servers/server_0.md git_push.sh migration_2_0_0.md diff --git a/samples/openapi3/client/3_0_3_unit_test/python/README.md b/samples/openapi3/client/3_0_3_unit_test/python/README.md index 766a6bde868..79bff42af43 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/README.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/README.md @@ -89,180 +89,180 @@ All URIs are relative to the selected server HTTP request | Method | Description ------------ | ------ | ------------- -/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/apis/tags/operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) | -/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/apis/tags/operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md) | -/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/apis/tags/operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md) | -/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/apis/tags/operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) | -/requestBody/postAllofCombinedWithAnyofOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/apis/tags/operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md) | -/requestBody/postAllofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_request_body](docs/apis/tags/operation_request_body_api/post_allof_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_request_body](docs/apis/tags/all_of_api/post_allof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_request_body](docs/apis/tags/path_post_api/post_allof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_request_body](docs/apis/tags/content_type_json_api/post_allof_request_body.md) | -/requestBody/postAllofSimpleTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_simple_types_request_body](docs/apis/tags/operation_request_body_api/post_allof_simple_types_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_simple_types_request_body](docs/apis/tags/all_of_api/post_allof_simple_types_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_simple_types_request_body](docs/apis/tags/path_post_api/post_allof_simple_types_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_simple_types_request_body](docs/apis/tags/content_type_json_api/post_allof_simple_types_request_body.md) | -/requestBody/postAllofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_base_schema_request_body](docs/apis/tags/operation_request_body_api/post_allof_with_base_schema_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_base_schema_request_body](docs/apis/tags/all_of_api/post_allof_with_base_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_base_schema_request_body](docs/apis/tags/path_post_api/post_allof_with_base_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_base_schema_request_body](docs/apis/tags/content_type_json_api/post_allof_with_base_schema_request_body.md) | -/requestBody/postAllofWithOneEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_one_empty_schema_request_body](docs/apis/tags/operation_request_body_api/post_allof_with_one_empty_schema_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_one_empty_schema_request_body](docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_one_empty_schema_request_body](docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_one_empty_schema_request_body](docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_request_body.md) | -/requestBody/postAllofWithTheFirstEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/apis/tags/operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md) | -/requestBody/postAllofWithTheLastEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/apis/tags/operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md) | -/requestBody/postAllofWithTwoEmptySchemasRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_two_empty_schemas_request_body](docs/apis/tags/operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_two_empty_schemas_request_body](docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_two_empty_schemas_request_body](docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_two_empty_schemas_request_body](docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_request_body.md) | -/requestBody/postAnyofComplexTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_complex_types_request_body](docs/apis/tags/operation_request_body_api/post_anyof_complex_types_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_complex_types_request_body](docs/apis/tags/path_post_api/post_anyof_complex_types_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_complex_types_request_body](docs/apis/tags/content_type_json_api/post_anyof_complex_types_request_body.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_complex_types_request_body](docs/apis/tags/any_of_api/post_anyof_complex_types_request_body.md) | -/requestBody/postAnyofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_request_body](docs/apis/tags/operation_request_body_api/post_anyof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_request_body](docs/apis/tags/path_post_api/post_anyof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_request_body](docs/apis/tags/content_type_json_api/post_anyof_request_body.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_request_body](docs/apis/tags/any_of_api/post_anyof_request_body.md) | -/requestBody/postAnyofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_with_base_schema_request_body](docs/apis/tags/operation_request_body_api/post_anyof_with_base_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_base_schema_request_body](docs/apis/tags/path_post_api/post_anyof_with_base_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_base_schema_request_body](docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_request_body.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_base_schema_request_body](docs/apis/tags/any_of_api/post_anyof_with_base_schema_request_body.md) | -/requestBody/postAnyofWithOneEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_with_one_empty_schema_request_body](docs/apis/tags/operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_one_empty_schema_request_body](docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_one_empty_schema_request_body](docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_request_body.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_one_empty_schema_request_body](docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_request_body.md) | -/requestBody/postArrayTypeMatchesArraysRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_array_type_matches_arrays_request_body](docs/apis/tags/operation_request_body_api/post_array_type_matches_arrays_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_array_type_matches_arrays_request_body](docs/apis/tags/path_post_api/post_array_type_matches_arrays_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_array_type_matches_arrays_request_body](docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_array_type_matches_arrays_request_body](docs/apis/tags/type_api/post_array_type_matches_arrays_request_body.md) | -/requestBody/postBooleanTypeMatchesBooleansRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_boolean_type_matches_booleans_request_body](docs/apis/tags/operation_request_body_api/post_boolean_type_matches_booleans_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_boolean_type_matches_booleans_request_body](docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_boolean_type_matches_booleans_request_body](docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_boolean_type_matches_booleans_request_body](docs/apis/tags/type_api/post_boolean_type_matches_booleans_request_body.md) | -/requestBody/postByIntRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_int_request_body](docs/apis/tags/multiple_of_api/post_by_int_request_body.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_int_request_body](docs/apis/tags/operation_request_body_api/post_by_int_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_int_request_body](docs/apis/tags/path_post_api/post_by_int_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_int_request_body](docs/apis/tags/content_type_json_api/post_by_int_request_body.md) | -/requestBody/postByNumberRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_number_request_body](docs/apis/tags/multiple_of_api/post_by_number_request_body.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_number_request_body](docs/apis/tags/operation_request_body_api/post_by_number_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_number_request_body](docs/apis/tags/path_post_api/post_by_number_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_number_request_body](docs/apis/tags/content_type_json_api/post_by_number_request_body.md) | -/requestBody/postBySmallNumberRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_small_number_request_body](docs/apis/tags/multiple_of_api/post_by_small_number_request_body.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_small_number_request_body](docs/apis/tags/operation_request_body_api/post_by_small_number_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_small_number_request_body](docs/apis/tags/path_post_api/post_by_small_number_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_small_number_request_body](docs/apis/tags/content_type_json_api/post_by_small_number_request_body.md) | -/requestBody/postDateTimeFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_date_time_format_request_body](docs/apis/tags/operation_request_body_api/post_date_time_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_date_time_format_request_body](docs/apis/tags/path_post_api/post_date_time_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_date_time_format_request_body](docs/apis/tags/content_type_json_api/post_date_time_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_date_time_format_request_body](docs/apis/tags/format_api/post_date_time_format_request_body.md) | -/requestBody/postEmailFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_email_format_request_body](docs/apis/tags/operation_request_body_api/post_email_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_email_format_request_body](docs/apis/tags/path_post_api/post_email_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_email_format_request_body](docs/apis/tags/content_type_json_api/post_email_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_email_format_request_body](docs/apis/tags/format_api/post_email_format_request_body.md) | -/requestBody/postEnumWith0DoesNotMatchFalseRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with0_does_not_match_false_request_body](docs/apis/tags/operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with0_does_not_match_false_request_body](docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with0_does_not_match_false_request_body](docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with0_does_not_match_false_request_body](docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_request_body.md) | -/requestBody/postEnumWith1DoesNotMatchTrueRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with1_does_not_match_true_request_body](docs/apis/tags/operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with1_does_not_match_true_request_body](docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with1_does_not_match_true_request_body](docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with1_does_not_match_true_request_body](docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_request_body.md) | -/requestBody/postEnumWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_escaped_characters_request_body](docs/apis/tags/operation_request_body_api/post_enum_with_escaped_characters_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_escaped_characters_request_body](docs/apis/tags/path_post_api/post_enum_with_escaped_characters_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_escaped_characters_request_body](docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_escaped_characters_request_body](docs/apis/tags/enum_api/post_enum_with_escaped_characters_request_body.md) | -/requestBody/postEnumWithFalseDoesNotMatch0RequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_false_does_not_match0_request_body](docs/apis/tags/operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_false_does_not_match0_request_body](docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_false_does_not_match0_request_body](docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_false_does_not_match0_request_body](docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_request_body.md) | -/requestBody/postEnumWithTrueDoesNotMatch1RequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_true_does_not_match1_request_body](docs/apis/tags/operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_true_does_not_match1_request_body](docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_true_does_not_match1_request_body](docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_true_does_not_match1_request_body](docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_request_body.md) | -/requestBody/postEnumsInPropertiesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enums_in_properties_request_body](docs/apis/tags/operation_request_body_api/post_enums_in_properties_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enums_in_properties_request_body](docs/apis/tags/path_post_api/post_enums_in_properties_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enums_in_properties_request_body](docs/apis/tags/content_type_json_api/post_enums_in_properties_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enums_in_properties_request_body](docs/apis/tags/enum_api/post_enums_in_properties_request_body.md) | -/requestBody/postForbiddenPropertyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_forbidden_property_request_body](docs/apis/tags/operation_request_body_api/post_forbidden_property_request_body.md) [_NotApi](docs/apis/tags/_not_api.md).[post_forbidden_property_request_body](docs/apis/tags/_not_api/post_forbidden_property_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_forbidden_property_request_body](docs/apis/tags/path_post_api/post_forbidden_property_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_forbidden_property_request_body](docs/apis/tags/content_type_json_api/post_forbidden_property_request_body.md) | -/requestBody/postHostnameFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_hostname_format_request_body](docs/apis/tags/operation_request_body_api/post_hostname_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_hostname_format_request_body](docs/apis/tags/path_post_api/post_hostname_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_hostname_format_request_body](docs/apis/tags/content_type_json_api/post_hostname_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_hostname_format_request_body](docs/apis/tags/format_api/post_hostname_format_request_body.md) | -/requestBody/postIntegerTypeMatchesIntegersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_integer_type_matches_integers_request_body](docs/apis/tags/operation_request_body_api/post_integer_type_matches_integers_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_integer_type_matches_integers_request_body](docs/apis/tags/path_post_api/post_integer_type_matches_integers_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_integer_type_matches_integers_request_body](docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_integer_type_matches_integers_request_body](docs/apis/tags/type_api/post_integer_type_matches_integers_request_body.md) | -/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/apis/tags/operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) | -/requestBody/postInvalidStringValueForDefaultRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_invalid_string_value_for_default_request_body](docs/apis/tags/operation_request_body_api/post_invalid_string_value_for_default_request_body.md) [DefaultApi](docs/apis/tags/default_api.md).[post_invalid_string_value_for_default_request_body](docs/apis/tags/default_api/post_invalid_string_value_for_default_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_string_value_for_default_request_body](docs/apis/tags/path_post_api/post_invalid_string_value_for_default_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_string_value_for_default_request_body](docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_request_body.md) | -/requestBody/postIpv4FormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ipv4_format_request_body](docs/apis/tags/operation_request_body_api/post_ipv4_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv4_format_request_body](docs/apis/tags/path_post_api/post_ipv4_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv4_format_request_body](docs/apis/tags/content_type_json_api/post_ipv4_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv4_format_request_body](docs/apis/tags/format_api/post_ipv4_format_request_body.md) | -/requestBody/postIpv6FormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ipv6_format_request_body](docs/apis/tags/operation_request_body_api/post_ipv6_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv6_format_request_body](docs/apis/tags/path_post_api/post_ipv6_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv6_format_request_body](docs/apis/tags/content_type_json_api/post_ipv6_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv6_format_request_body](docs/apis/tags/format_api/post_ipv6_format_request_body.md) | -/requestBody/postJsonPointerFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_json_pointer_format_request_body](docs/apis/tags/operation_request_body_api/post_json_pointer_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_json_pointer_format_request_body](docs/apis/tags/path_post_api/post_json_pointer_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_json_pointer_format_request_body](docs/apis/tags/content_type_json_api/post_json_pointer_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_json_pointer_format_request_body](docs/apis/tags/format_api/post_json_pointer_format_request_body.md) | -/requestBody/postMaximumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maximum_validation_request_body](docs/apis/tags/operation_request_body_api/post_maximum_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_request_body](docs/apis/tags/path_post_api/post_maximum_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_request_body](docs/apis/tags/content_type_json_api/post_maximum_validation_request_body.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_request_body](docs/apis/tags/maximum_api/post_maximum_validation_request_body.md) | -/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/apis/tags/operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md) | -/requestBody/postMaxitemsValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxitems_validation_request_body](docs/apis/tags/operation_request_body_api/post_maxitems_validation_request_body.md) [MaxItemsApi](docs/apis/tags/max_items_api.md).[post_maxitems_validation_request_body](docs/apis/tags/max_items_api/post_maxitems_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxitems_validation_request_body](docs/apis/tags/path_post_api/post_maxitems_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxitems_validation_request_body](docs/apis/tags/content_type_json_api/post_maxitems_validation_request_body.md) | -/requestBody/postMaxlengthValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxlength_validation_request_body](docs/apis/tags/operation_request_body_api/post_maxlength_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxlength_validation_request_body](docs/apis/tags/path_post_api/post_maxlength_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxlength_validation_request_body](docs/apis/tags/content_type_json_api/post_maxlength_validation_request_body.md) [MaxLengthApi](docs/apis/tags/max_length_api.md).[post_maxlength_validation_request_body](docs/apis/tags/max_length_api/post_maxlength_validation_request_body.md) | -/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/apis/tags/operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md) | -/requestBody/postMaxpropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxproperties_validation_request_body](docs/apis/tags/operation_request_body_api/post_maxproperties_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties_validation_request_body](docs/apis/tags/path_post_api/post_maxproperties_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties_validation_request_body](docs/apis/tags/content_type_json_api/post_maxproperties_validation_request_body.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties_validation_request_body](docs/apis/tags/max_properties_api/post_maxproperties_validation_request_body.md) | -/requestBody/postMinimumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minimum_validation_request_body](docs/apis/tags/operation_request_body_api/post_minimum_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_request_body](docs/apis/tags/path_post_api/post_minimum_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_request_body](docs/apis/tags/content_type_json_api/post_minimum_validation_request_body.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_request_body](docs/apis/tags/minimum_api/post_minimum_validation_request_body.md) | -/requestBody/postMinimumValidationWithSignedIntegerRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/apis/tags/operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_request_body.md) | -/requestBody/postMinitemsValidationRequestBody **post** | [MinItemsApi](docs/apis/tags/min_items_api.md).[post_minitems_validation_request_body](docs/apis/tags/min_items_api/post_minitems_validation_request_body.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minitems_validation_request_body](docs/apis/tags/operation_request_body_api/post_minitems_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minitems_validation_request_body](docs/apis/tags/path_post_api/post_minitems_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minitems_validation_request_body](docs/apis/tags/content_type_json_api/post_minitems_validation_request_body.md) | -/requestBody/postMinlengthValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minlength_validation_request_body](docs/apis/tags/operation_request_body_api/post_minlength_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minlength_validation_request_body](docs/apis/tags/path_post_api/post_minlength_validation_request_body.md) [MinLengthApi](docs/apis/tags/min_length_api.md).[post_minlength_validation_request_body](docs/apis/tags/min_length_api/post_minlength_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minlength_validation_request_body](docs/apis/tags/content_type_json_api/post_minlength_validation_request_body.md) | -/requestBody/postMinpropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minproperties_validation_request_body](docs/apis/tags/operation_request_body_api/post_minproperties_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minproperties_validation_request_body](docs/apis/tags/path_post_api/post_minproperties_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minproperties_validation_request_body](docs/apis/tags/content_type_json_api/post_minproperties_validation_request_body.md) [MinPropertiesApi](docs/apis/tags/min_properties_api.md).[post_minproperties_validation_request_body](docs/apis/tags/min_properties_api/post_minproperties_validation_request_body.md) | -/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/apis/tags/operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md) | -/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/apis/tags/operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md) | -/requestBody/postNestedItemsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_items_request_body](docs/apis/tags/operation_request_body_api/post_nested_items_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_items_request_body](docs/apis/tags/path_post_api/post_nested_items_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_items_request_body](docs/apis/tags/content_type_json_api/post_nested_items_request_body.md) [ItemsApi](docs/apis/tags/items_api.md).[post_nested_items_request_body](docs/apis/tags/items_api/post_nested_items_request_body.md) | -/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/apis/tags/operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md) | -/requestBody/postNotMoreComplexSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_not_more_complex_schema_request_body](docs/apis/tags/operation_request_body_api/post_not_more_complex_schema_request_body.md) [_NotApi](docs/apis/tags/_not_api.md).[post_not_more_complex_schema_request_body](docs/apis/tags/_not_api/post_not_more_complex_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_more_complex_schema_request_body](docs/apis/tags/path_post_api/post_not_more_complex_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_more_complex_schema_request_body](docs/apis/tags/content_type_json_api/post_not_more_complex_schema_request_body.md) | -/requestBody/postNotRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_not_request_body](docs/apis/tags/operation_request_body_api/post_not_request_body.md) [_NotApi](docs/apis/tags/_not_api.md).[post_not_request_body](docs/apis/tags/_not_api/post_not_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_request_body](docs/apis/tags/path_post_api/post_not_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_request_body](docs/apis/tags/content_type_json_api/post_not_request_body.md) | -/requestBody/postNulCharactersInStringsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nul_characters_in_strings_request_body](docs/apis/tags/operation_request_body_api/post_nul_characters_in_strings_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nul_characters_in_strings_request_body](docs/apis/tags/path_post_api/post_nul_characters_in_strings_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nul_characters_in_strings_request_body](docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_nul_characters_in_strings_request_body](docs/apis/tags/enum_api/post_nul_characters_in_strings_request_body.md) | -/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/apis/tags/operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_request_body.md) | -/requestBody/postNumberTypeMatchesNumbersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_number_type_matches_numbers_request_body](docs/apis/tags/operation_request_body_api/post_number_type_matches_numbers_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_number_type_matches_numbers_request_body](docs/apis/tags/path_post_api/post_number_type_matches_numbers_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_number_type_matches_numbers_request_body](docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_number_type_matches_numbers_request_body](docs/apis/tags/type_api/post_number_type_matches_numbers_request_body.md) | -/requestBody/postObjectPropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_object_properties_validation_request_body](docs/apis/tags/operation_request_body_api/post_object_properties_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_properties_validation_request_body](docs/apis/tags/path_post_api/post_object_properties_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_properties_validation_request_body](docs/apis/tags/content_type_json_api/post_object_properties_validation_request_body.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_object_properties_validation_request_body](docs/apis/tags/properties_api/post_object_properties_validation_request_body.md) | -/requestBody/postObjectTypeMatchesObjectsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_object_type_matches_objects_request_body](docs/apis/tags/operation_request_body_api/post_object_type_matches_objects_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_type_matches_objects_request_body](docs/apis/tags/path_post_api/post_object_type_matches_objects_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_type_matches_objects_request_body](docs/apis/tags/content_type_json_api/post_object_type_matches_objects_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_object_type_matches_objects_request_body](docs/apis/tags/type_api/post_object_type_matches_objects_request_body.md) | -/requestBody/postOneofComplexTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_complex_types_request_body](docs/apis/tags/operation_request_body_api/post_oneof_complex_types_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_complex_types_request_body](docs/apis/tags/one_of_api/post_oneof_complex_types_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_complex_types_request_body](docs/apis/tags/path_post_api/post_oneof_complex_types_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_complex_types_request_body](docs/apis/tags/content_type_json_api/post_oneof_complex_types_request_body.md) | -/requestBody/postOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_request_body](docs/apis/tags/operation_request_body_api/post_oneof_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_request_body](docs/apis/tags/one_of_api/post_oneof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_request_body](docs/apis/tags/path_post_api/post_oneof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_request_body](docs/apis/tags/content_type_json_api/post_oneof_request_body.md) | -/requestBody/postOneofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_base_schema_request_body](docs/apis/tags/operation_request_body_api/post_oneof_with_base_schema_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_base_schema_request_body](docs/apis/tags/one_of_api/post_oneof_with_base_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_base_schema_request_body](docs/apis/tags/path_post_api/post_oneof_with_base_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_base_schema_request_body](docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_request_body.md) | -/requestBody/postOneofWithEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_empty_schema_request_body](docs/apis/tags/operation_request_body_api/post_oneof_with_empty_schema_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_empty_schema_request_body](docs/apis/tags/one_of_api/post_oneof_with_empty_schema_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_empty_schema_request_body](docs/apis/tags/path_post_api/post_oneof_with_empty_schema_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_empty_schema_request_body](docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_request_body.md) | -/requestBody/postOneofWithRequiredRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_required_request_body](docs/apis/tags/operation_request_body_api/post_oneof_with_required_request_body.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_required_request_body](docs/apis/tags/one_of_api/post_oneof_with_required_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_required_request_body](docs/apis/tags/path_post_api/post_oneof_with_required_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_required_request_body](docs/apis/tags/content_type_json_api/post_oneof_with_required_request_body.md) | -/requestBody/postPatternIsNotAnchoredRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_pattern_is_not_anchored_request_body](docs/apis/tags/operation_request_body_api/post_pattern_is_not_anchored_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_is_not_anchored_request_body](docs/apis/tags/path_post_api/post_pattern_is_not_anchored_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_is_not_anchored_request_body](docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_request_body.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_is_not_anchored_request_body](docs/apis/tags/pattern_api/post_pattern_is_not_anchored_request_body.md) | -/requestBody/postPatternValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_pattern_validation_request_body](docs/apis/tags/operation_request_body_api/post_pattern_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_validation_request_body](docs/apis/tags/path_post_api/post_pattern_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_validation_request_body](docs/apis/tags/content_type_json_api/post_pattern_validation_request_body.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_validation_request_body](docs/apis/tags/pattern_api/post_pattern_validation_request_body.md) | -/requestBody/postPropertiesWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_properties_with_escaped_characters_request_body](docs/apis/tags/operation_request_body_api/post_properties_with_escaped_characters_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_properties_with_escaped_characters_request_body](docs/apis/tags/path_post_api/post_properties_with_escaped_characters_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_properties_with_escaped_characters_request_body](docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_request_body.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_properties_with_escaped_characters_request_body](docs/apis/tags/properties_api/post_properties_with_escaped_characters_request_body.md) | -/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/apis/tags/operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md) | -/requestBody/postRefInAdditionalpropertiesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_additionalproperties_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_additionalproperties_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_additionalproperties_request_body](docs/apis/tags/path_post_api/post_ref_in_additionalproperties_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_additionalproperties_request_body](docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_additionalproperties_request_body](docs/apis/tags/ref_api/post_ref_in_additionalproperties_request_body.md) | -/requestBody/postRefInAllofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_allof_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_allof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_allof_request_body](docs/apis/tags/path_post_api/post_ref_in_allof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_allof_request_body](docs/apis/tags/content_type_json_api/post_ref_in_allof_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_allof_request_body](docs/apis/tags/ref_api/post_ref_in_allof_request_body.md) | -/requestBody/postRefInAnyofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_anyof_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_anyof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_anyof_request_body](docs/apis/tags/path_post_api/post_ref_in_anyof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_anyof_request_body](docs/apis/tags/content_type_json_api/post_ref_in_anyof_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_anyof_request_body](docs/apis/tags/ref_api/post_ref_in_anyof_request_body.md) | -/requestBody/postRefInItemsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_items_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_items_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_items_request_body](docs/apis/tags/path_post_api/post_ref_in_items_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_items_request_body](docs/apis/tags/content_type_json_api/post_ref_in_items_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_items_request_body](docs/apis/tags/ref_api/post_ref_in_items_request_body.md) | -/requestBody/postRefInNotRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_not_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_not_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_not_request_body](docs/apis/tags/path_post_api/post_ref_in_not_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_not_request_body](docs/apis/tags/content_type_json_api/post_ref_in_not_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_not_request_body](docs/apis/tags/ref_api/post_ref_in_not_request_body.md) | -/requestBody/postRefInOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_oneof_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_oneof_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_oneof_request_body](docs/apis/tags/path_post_api/post_ref_in_oneof_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_oneof_request_body](docs/apis/tags/content_type_json_api/post_ref_in_oneof_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_oneof_request_body](docs/apis/tags/ref_api/post_ref_in_oneof_request_body.md) | -/requestBody/postRefInPropertyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_property_request_body](docs/apis/tags/operation_request_body_api/post_ref_in_property_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_property_request_body](docs/apis/tags/path_post_api/post_ref_in_property_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_property_request_body](docs/apis/tags/content_type_json_api/post_ref_in_property_request_body.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_property_request_body](docs/apis/tags/ref_api/post_ref_in_property_request_body.md) | -/requestBody/postRequiredDefaultValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_default_validation_request_body](docs/apis/tags/operation_request_body_api/post_required_default_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_default_validation_request_body](docs/apis/tags/path_post_api/post_required_default_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_default_validation_request_body](docs/apis/tags/content_type_json_api/post_required_default_validation_request_body.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_default_validation_request_body](docs/apis/tags/required_api/post_required_default_validation_request_body.md) | -/requestBody/postRequiredValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_validation_request_body](docs/apis/tags/operation_request_body_api/post_required_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_validation_request_body](docs/apis/tags/path_post_api/post_required_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_validation_request_body](docs/apis/tags/content_type_json_api/post_required_validation_request_body.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_validation_request_body](docs/apis/tags/required_api/post_required_validation_request_body.md) | -/requestBody/postRequiredWithEmptyArrayRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_with_empty_array_request_body](docs/apis/tags/operation_request_body_api/post_required_with_empty_array_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_empty_array_request_body](docs/apis/tags/path_post_api/post_required_with_empty_array_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_empty_array_request_body](docs/apis/tags/content_type_json_api/post_required_with_empty_array_request_body.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_empty_array_request_body](docs/apis/tags/required_api/post_required_with_empty_array_request_body.md) | -/requestBody/postRequiredWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_with_escaped_characters_request_body](docs/apis/tags/operation_request_body_api/post_required_with_escaped_characters_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_escaped_characters_request_body](docs/apis/tags/path_post_api/post_required_with_escaped_characters_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_escaped_characters_request_body](docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_request_body.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_escaped_characters_request_body](docs/apis/tags/required_api/post_required_with_escaped_characters_request_body.md) | -/requestBody/postSimpleEnumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_simple_enum_validation_request_body](docs/apis/tags/operation_request_body_api/post_simple_enum_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_simple_enum_validation_request_body](docs/apis/tags/path_post_api/post_simple_enum_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_simple_enum_validation_request_body](docs/apis/tags/content_type_json_api/post_simple_enum_validation_request_body.md) [EnumApi](docs/apis/tags/enum_api.md).[post_simple_enum_validation_request_body](docs/apis/tags/enum_api/post_simple_enum_validation_request_body.md) | -/requestBody/postStringTypeMatchesStringsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_string_type_matches_strings_request_body](docs/apis/tags/operation_request_body_api/post_string_type_matches_strings_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_string_type_matches_strings_request_body](docs/apis/tags/path_post_api/post_string_type_matches_strings_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_string_type_matches_strings_request_body](docs/apis/tags/content_type_json_api/post_string_type_matches_strings_request_body.md) [TypeApi](docs/apis/tags/type_api.md).[post_string_type_matches_strings_request_body](docs/apis/tags/type_api/post_string_type_matches_strings_request_body.md) | -/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/apis/tags/operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) [DefaultApi](docs/apis/tags/default_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) | -/requestBody/postUniqueitemsFalseValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uniqueitems_false_validation_request_body](docs/apis/tags/operation_request_body_api/post_uniqueitems_false_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_false_validation_request_body](docs/apis/tags/path_post_api/post_uniqueitems_false_validation_request_body.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_false_validation_request_body](docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_false_validation_request_body](docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_request_body.md) | -/requestBody/postUniqueitemsValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uniqueitems_validation_request_body](docs/apis/tags/operation_request_body_api/post_uniqueitems_validation_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_validation_request_body](docs/apis/tags/path_post_api/post_uniqueitems_validation_request_body.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_validation_request_body](docs/apis/tags/unique_items_api/post_uniqueitems_validation_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_validation_request_body](docs/apis/tags/content_type_json_api/post_uniqueitems_validation_request_body.md) | -/requestBody/postUriFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_format_request_body](docs/apis/tags/operation_request_body_api/post_uri_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_format_request_body](docs/apis/tags/path_post_api/post_uri_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_format_request_body](docs/apis/tags/content_type_json_api/post_uri_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_format_request_body](docs/apis/tags/format_api/post_uri_format_request_body.md) | -/requestBody/postUriReferenceFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_reference_format_request_body](docs/apis/tags/operation_request_body_api/post_uri_reference_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_reference_format_request_body](docs/apis/tags/path_post_api/post_uri_reference_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_reference_format_request_body](docs/apis/tags/content_type_json_api/post_uri_reference_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_reference_format_request_body](docs/apis/tags/format_api/post_uri_reference_format_request_body.md) | -/requestBody/postUriTemplateFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_template_format_request_body](docs/apis/tags/operation_request_body_api/post_uri_template_format_request_body.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_template_format_request_body](docs/apis/tags/path_post_api/post_uri_template_format_request_body.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_template_format_request_body](docs/apis/tags/content_type_json_api/post_uri_template_format_request_body.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_template_format_request_body](docs/apis/tags/format_api/post_uri_template_format_request_body.md) | -/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) | -/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) | -/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) | -/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) | -/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) | -/responseBody/postAllofResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_response_body_for_content_types.md) | -/responseBody/postAllofSimpleTypesResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_simple_types_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_simple_types_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_simple_types_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_simple_types_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_simple_types_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_simple_types_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_simple_types_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md) | -/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_with_base_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_with_base_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md) | -/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) | -/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) | -/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) | -/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) | -/responseBody/postAnyofComplexTypesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/apis/tags/path_post_api/post_anyof_complex_types_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/apis/tags/any_of_api/post_anyof_complex_types_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md) | -/responseBody/postAnyofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_response_body_for_content_types](docs/apis/tags/path_post_api/post_anyof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_anyof_response_body_for_content_types.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_response_body_for_content_types](docs/apis/tags/any_of_api/post_anyof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md) | -/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/apis/tags/any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md) | -/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) | -/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/apis/tags/path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/apis/tags/type_api/post_array_type_matches_arrays_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md) | -/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/apis/tags/type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) | -/responseBody/postByIntResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_int_response_body_for_content_types](docs/apis/tags/multiple_of_api/post_by_int_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_int_response_body_for_content_types](docs/apis/tags/path_post_api/post_by_int_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_int_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_by_int_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_int_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md) | -/responseBody/postByNumberResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_number_response_body_for_content_types](docs/apis/tags/multiple_of_api/post_by_number_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_number_response_body_for_content_types](docs/apis/tags/path_post_api/post_by_number_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_number_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_by_number_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_number_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md) | -/responseBody/postBySmallNumberResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_small_number_response_body_for_content_types](docs/apis/tags/multiple_of_api/post_by_small_number_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_small_number_response_body_for_content_types](docs/apis/tags/path_post_api/post_by_small_number_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_small_number_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_by_small_number_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_small_number_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md) | -/responseBody/postDateTimeFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_date_time_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_date_time_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_date_time_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_date_time_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_date_time_format_response_body_for_content_types](docs/apis/tags/format_api/post_date_time_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_date_time_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md) | -/responseBody/postEmailFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_email_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_email_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_email_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_email_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_email_format_response_body_for_content_types](docs/apis/tags/format_api/post_email_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_email_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md) | -/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) | -/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) | -/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/apis/tags/path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/apis/tags/enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md) | -/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) | -/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) | -/responseBody/postEnumsInPropertiesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enums_in_properties_response_body_for_content_types](docs/apis/tags/path_post_api/post_enums_in_properties_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enums_in_properties_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_enums_in_properties_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enums_in_properties_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enums_in_properties_response_body_for_content_types](docs/apis/tags/enum_api/post_enums_in_properties_response_body_for_content_types.md) | -/responseBody/postForbiddenPropertyResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_forbidden_property_response_body_for_content_types](docs/apis/tags/_not_api/post_forbidden_property_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_forbidden_property_response_body_for_content_types](docs/apis/tags/path_post_api/post_forbidden_property_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_forbidden_property_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_forbidden_property_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_forbidden_property_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md) | -/responseBody/postHostnameFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_hostname_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_hostname_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_hostname_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_hostname_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_hostname_format_response_body_for_content_types](docs/apis/tags/format_api/post_hostname_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_hostname_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md) | -/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/apis/tags/path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/apis/tags/type_api/post_integer_type_matches_integers_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md) | -/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) | -/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/apis/tags/default_api/post_invalid_string_value_for_default_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/apis/tags/path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md) | -/responseBody/postIpv4FormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv4_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_ipv4_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv4_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ipv4_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv4_format_response_body_for_content_types](docs/apis/tags/format_api/post_ipv4_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ipv4_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md) | -/responseBody/postIpv6FormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv6_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_ipv6_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv6_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ipv6_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv6_format_response_body_for_content_types](docs/apis/tags/format_api/post_ipv6_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ipv6_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md) | -/responseBody/postJsonPointerFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_json_pointer_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_json_pointer_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_json_pointer_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_json_pointer_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_json_pointer_format_response_body_for_content_types](docs/apis/tags/format_api/post_json_pointer_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_json_pointer_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md) | -/responseBody/postMaximumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_maximum_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maximum_validation_response_body_for_content_types.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_response_body_for_content_types](docs/apis/tags/maximum_api/post_maximum_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maximum_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md) | -/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) | -/responseBody/postMaxitemsValidationResponseBodyForContentTypes **post** | [MaxItemsApi](docs/apis/tags/max_items_api.md).[post_maxitems_validation_response_body_for_content_types](docs/apis/tags/max_items_api/post_maxitems_validation_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxitems_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_maxitems_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxitems_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maxitems_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxitems_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md) | -/responseBody/postMaxlengthValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxlength_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_maxlength_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxlength_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maxlength_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxlength_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md) [MaxLengthApi](docs/apis/tags/max_length_api.md).[post_maxlength_validation_response_body_for_content_types](docs/apis/tags/max_length_api/post_maxlength_validation_response_body_for_content_types.md) | -/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) | -/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_maxproperties_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/apis/tags/max_properties_api/post_maxproperties_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md) | -/responseBody/postMinimumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_minimum_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_minimum_validation_response_body_for_content_types.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_response_body_for_content_types](docs/apis/tags/minimum_api/post_minimum_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minimum_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md) | -/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) | -/responseBody/postMinitemsValidationResponseBodyForContentTypes **post** | [MinItemsApi](docs/apis/tags/min_items_api.md).[post_minitems_validation_response_body_for_content_types](docs/apis/tags/min_items_api/post_minitems_validation_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minitems_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_minitems_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minitems_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_minitems_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minitems_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md) | -/responseBody/postMinlengthValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minlength_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_minlength_validation_response_body_for_content_types.md) [MinLengthApi](docs/apis/tags/min_length_api.md).[post_minlength_validation_response_body_for_content_types](docs/apis/tags/min_length_api/post_minlength_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minlength_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_minlength_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minlength_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md) | -/responseBody/postMinpropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minproperties_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_minproperties_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minproperties_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_minproperties_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minproperties_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md) [MinPropertiesApi](docs/apis/tags/min_properties_api.md).[post_minproperties_validation_response_body_for_content_types](docs/apis/tags/min_properties_api/post_minproperties_validation_response_body_for_content_types.md) | -/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) | -/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) | -/responseBody/postNestedItemsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_items_response_body_for_content_types](docs/apis/tags/path_post_api/post_nested_items_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_items_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_nested_items_response_body_for_content_types.md) [ItemsApi](docs/apis/tags/items_api.md).[post_nested_items_response_body_for_content_types](docs/apis/tags/items_api/post_nested_items_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_items_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md) | -/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) | -/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/apis/tags/_not_api/post_not_more_complex_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_not_more_complex_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md) | -/responseBody/postNotResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_not_response_body_for_content_types](docs/apis/tags/_not_api/post_not_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_response_body_for_content_types](docs/apis/tags/path_post_api/post_not_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_not_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_not_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_not_response_body_for_content_types.md) | -/responseBody/postNulCharactersInStringsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/apis/tags/path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/apis/tags/enum_api/post_nul_characters_in_strings_response_body_for_content_types.md) | -/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) | -/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/apis/tags/path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/apis/tags/type_api/post_number_type_matches_numbers_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md) | -/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_properties_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_object_properties_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_properties_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_object_properties_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_object_properties_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_object_properties_validation_response_body_for_content_types](docs/apis/tags/properties_api/post_object_properties_validation_response_body_for_content_types.md) | -/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/apis/tags/path_post_api/post_object_type_matches_objects_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/apis/tags/type_api/post_object_type_matches_objects_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md) | -/responseBody/postOneofComplexTypesResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/apis/tags/one_of_api/post_oneof_complex_types_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/apis/tags/path_post_api/post_oneof_complex_types_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md) | -/responseBody/postOneofResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_response_body_for_content_types](docs/apis/tags/one_of_api/post_oneof_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_response_body_for_content_types](docs/apis/tags/path_post_api/post_oneof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_oneof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md) | -/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/apis/tags/one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md) | -/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/apis/tags/one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/apis/tags/path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md) | -/responseBody/postOneofWithRequiredResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_required_response_body_for_content_types](docs/apis/tags/one_of_api/post_oneof_with_required_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_required_response_body_for_content_types](docs/apis/tags/path_post_api/post_oneof_with_required_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_required_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_oneof_with_required_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_required_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md) | -/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/apis/tags/path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/apis/tags/pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md) | -/responseBody/postPatternValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_pattern_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_pattern_validation_response_body_for_content_types.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_validation_response_body_for_content_types](docs/apis/tags/pattern_api/post_pattern_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_pattern_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md) | -/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/apis/tags/path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/apis/tags/properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md) | -/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) | -/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md) | -/responseBody/postRefInAllofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_allof_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_allof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_allof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_allof_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_allof_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_allof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_allof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md) | -/responseBody/postRefInAnyofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_anyof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_anyof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md) | -/responseBody/postRefInItemsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_items_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_items_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_items_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_items_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_items_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_items_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_items_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md) | -/responseBody/postRefInNotResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_not_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_not_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_not_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_not_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_not_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_not_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_not_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md) | -/responseBody/postRefInOneofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_oneof_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_oneof_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md) | -/responseBody/postRefInPropertyResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_property_response_body_for_content_types](docs/apis/tags/path_post_api/post_ref_in_property_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_property_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_ref_in_property_response_body_for_content_types.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_property_response_body_for_content_types](docs/apis/tags/ref_api/post_ref_in_property_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_property_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md) | -/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_default_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_required_default_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_default_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_required_default_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_default_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_default_validation_response_body_for_content_types](docs/apis/tags/required_api/post_required_default_validation_response_body_for_content_types.md) | -/responseBody/postRequiredValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_required_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_required_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_validation_response_body_for_content_types](docs/apis/tags/required_api/post_required_validation_response_body_for_content_types.md) | -/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/apis/tags/path_post_api/post_required_with_empty_array_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/apis/tags/required_api/post_required_with_empty_array_response_body_for_content_types.md) | -/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/apis/tags/path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/apis/tags/required_api/post_required_with_escaped_characters_response_body_for_content_types.md) | -/responseBody/postSimpleEnumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_simple_enum_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md) [EnumApi](docs/apis/tags/enum_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/apis/tags/enum_api/post_simple_enum_validation_response_body_for_content_types.md) | -/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/apis/tags/path_post_api/post_string_type_matches_strings_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md) [TypeApi](docs/apis/tags/type_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/apis/tags/type_api/post_string_type_matches_strings_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md) | -/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) | -/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md) | -/responseBody/postUniqueitemsValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/apis/tags/path_post_api/post_uniqueitems_validation_response_body_for_content_types.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/apis/tags/unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md) | -/responseBody/postUriFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_uri_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_uri_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_format_response_body_for_content_types](docs/apis/tags/format_api/post_uri_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md) | -/responseBody/postUriReferenceFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_reference_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_uri_reference_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_reference_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_uri_reference_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_reference_format_response_body_for_content_types](docs/apis/tags/format_api/post_uri_reference_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_reference_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md) | -/responseBody/postUriTemplateFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_template_format_response_body_for_content_types](docs/apis/tags/path_post_api/post_uri_template_format_response_body_for_content_types.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_template_format_response_body_for_content_types](docs/apis/tags/content_type_json_api/post_uri_template_format_response_body_for_content_types.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_template_format_response_body_for_content_types](docs/apis/tags/format_api/post_uri_template_format_response_body_for_content_types.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_template_format_response_body_for_content_types](docs/apis/tags/response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md) | +/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_request_body](docs/paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) | +/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_are_allowed_by_default_request_body](docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) | +/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_can_exist_by_itself_request_body](docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) | +/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_should_not_look_in_applicators_request_body](docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) | +/requestBody/postAllofCombinedWithAnyofOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_combined_with_anyof_oneof_request_body](docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) | +/requestBody/postAllofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_request_body](docs/paths/request_body_post_allof_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_request_body](docs/paths/request_body_post_allof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_request_body](docs/paths/request_body_post_allof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_request_body](docs/paths/request_body_post_allof_request_body/post.md) | +/requestBody/postAllofSimpleTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_simple_types_request_body](docs/paths/request_body_post_allof_simple_types_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_simple_types_request_body](docs/paths/request_body_post_allof_simple_types_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_simple_types_request_body](docs/paths/request_body_post_allof_simple_types_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_simple_types_request_body](docs/paths/request_body_post_allof_simple_types_request_body/post.md) | +/requestBody/postAllofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_base_schema_request_body](docs/paths/request_body_post_allof_with_base_schema_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_base_schema_request_body](docs/paths/request_body_post_allof_with_base_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_base_schema_request_body](docs/paths/request_body_post_allof_with_base_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_base_schema_request_body](docs/paths/request_body_post_allof_with_base_schema_request_body/post.md) | +/requestBody/postAllofWithOneEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_one_empty_schema_request_body](docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_one_empty_schema_request_body](docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_one_empty_schema_request_body](docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_one_empty_schema_request_body](docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) | +/requestBody/postAllofWithTheFirstEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_first_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) | +/requestBody/postAllofWithTheLastEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_last_empty_schema_request_body](docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) | +/requestBody/postAllofWithTwoEmptySchemasRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_allof_with_two_empty_schemas_request_body](docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_two_empty_schemas_request_body](docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_two_empty_schemas_request_body](docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_two_empty_schemas_request_body](docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) | +/requestBody/postAnyofComplexTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_complex_types_request_body](docs/paths/request_body_post_anyof_complex_types_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_complex_types_request_body](docs/paths/request_body_post_anyof_complex_types_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_complex_types_request_body](docs/paths/request_body_post_anyof_complex_types_request_body/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_complex_types_request_body](docs/paths/request_body_post_anyof_complex_types_request_body/post.md) | +/requestBody/postAnyofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_request_body](docs/paths/request_body_post_anyof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_request_body](docs/paths/request_body_post_anyof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_request_body](docs/paths/request_body_post_anyof_request_body/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_request_body](docs/paths/request_body_post_anyof_request_body/post.md) | +/requestBody/postAnyofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_with_base_schema_request_body](docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_base_schema_request_body](docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_base_schema_request_body](docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_base_schema_request_body](docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md) | +/requestBody/postAnyofWithOneEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_anyof_with_one_empty_schema_request_body](docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_one_empty_schema_request_body](docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_one_empty_schema_request_body](docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_one_empty_schema_request_body](docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) | +/requestBody/postArrayTypeMatchesArraysRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_array_type_matches_arrays_request_body](docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_array_type_matches_arrays_request_body](docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_array_type_matches_arrays_request_body](docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_array_type_matches_arrays_request_body](docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md) | +/requestBody/postBooleanTypeMatchesBooleansRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_boolean_type_matches_booleans_request_body](docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_boolean_type_matches_booleans_request_body](docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_boolean_type_matches_booleans_request_body](docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_boolean_type_matches_booleans_request_body](docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) | +/requestBody/postByIntRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_int_request_body](docs/paths/request_body_post_by_int_request_body/post.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_int_request_body](docs/paths/request_body_post_by_int_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_int_request_body](docs/paths/request_body_post_by_int_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_int_request_body](docs/paths/request_body_post_by_int_request_body/post.md) | +/requestBody/postByNumberRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_number_request_body](docs/paths/request_body_post_by_number_request_body/post.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_number_request_body](docs/paths/request_body_post_by_number_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_number_request_body](docs/paths/request_body_post_by_number_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_number_request_body](docs/paths/request_body_post_by_number_request_body/post.md) | +/requestBody/postBySmallNumberRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_small_number_request_body](docs/paths/request_body_post_by_small_number_request_body/post.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_by_small_number_request_body](docs/paths/request_body_post_by_small_number_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_small_number_request_body](docs/paths/request_body_post_by_small_number_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_small_number_request_body](docs/paths/request_body_post_by_small_number_request_body/post.md) | +/requestBody/postDateTimeFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_date_time_format_request_body](docs/paths/request_body_post_date_time_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_date_time_format_request_body](docs/paths/request_body_post_date_time_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_date_time_format_request_body](docs/paths/request_body_post_date_time_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_date_time_format_request_body](docs/paths/request_body_post_date_time_format_request_body/post.md) | +/requestBody/postEmailFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_email_format_request_body](docs/paths/request_body_post_email_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_email_format_request_body](docs/paths/request_body_post_email_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_email_format_request_body](docs/paths/request_body_post_email_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_email_format_request_body](docs/paths/request_body_post_email_format_request_body/post.md) | +/requestBody/postEnumWith0DoesNotMatchFalseRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with0_does_not_match_false_request_body](docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with0_does_not_match_false_request_body](docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with0_does_not_match_false_request_body](docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with0_does_not_match_false_request_body](docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) | +/requestBody/postEnumWith1DoesNotMatchTrueRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with1_does_not_match_true_request_body](docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with1_does_not_match_true_request_body](docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with1_does_not_match_true_request_body](docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with1_does_not_match_true_request_body](docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) | +/requestBody/postEnumWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_escaped_characters_request_body](docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_escaped_characters_request_body](docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_escaped_characters_request_body](docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_escaped_characters_request_body](docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md) | +/requestBody/postEnumWithFalseDoesNotMatch0RequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_false_does_not_match0_request_body](docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_false_does_not_match0_request_body](docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_false_does_not_match0_request_body](docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_false_does_not_match0_request_body](docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) | +/requestBody/postEnumWithTrueDoesNotMatch1RequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enum_with_true_does_not_match1_request_body](docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_true_does_not_match1_request_body](docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_true_does_not_match1_request_body](docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_true_does_not_match1_request_body](docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) | +/requestBody/postEnumsInPropertiesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_enums_in_properties_request_body](docs/paths/request_body_post_enums_in_properties_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_enums_in_properties_request_body](docs/paths/request_body_post_enums_in_properties_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enums_in_properties_request_body](docs/paths/request_body_post_enums_in_properties_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enums_in_properties_request_body](docs/paths/request_body_post_enums_in_properties_request_body/post.md) | +/requestBody/postForbiddenPropertyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_forbidden_property_request_body](docs/paths/request_body_post_forbidden_property_request_body/post.md) [_NotApi](docs/apis/tags/_not_api.md).[post_forbidden_property_request_body](docs/paths/request_body_post_forbidden_property_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_forbidden_property_request_body](docs/paths/request_body_post_forbidden_property_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_forbidden_property_request_body](docs/paths/request_body_post_forbidden_property_request_body/post.md) | +/requestBody/postHostnameFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_hostname_format_request_body](docs/paths/request_body_post_hostname_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_hostname_format_request_body](docs/paths/request_body_post_hostname_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_hostname_format_request_body](docs/paths/request_body_post_hostname_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_hostname_format_request_body](docs/paths/request_body_post_hostname_format_request_body/post.md) | +/requestBody/postIntegerTypeMatchesIntegersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_integer_type_matches_integers_request_body](docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_integer_type_matches_integers_request_body](docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_integer_type_matches_integers_request_body](docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_integer_type_matches_integers_request_body](docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md) | +/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body](docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) | +/requestBody/postInvalidStringValueForDefaultRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_invalid_string_value_for_default_request_body](docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md) [DefaultApi](docs/apis/tags/default_api.md).[post_invalid_string_value_for_default_request_body](docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_string_value_for_default_request_body](docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_string_value_for_default_request_body](docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md) | +/requestBody/postIpv4FormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ipv4_format_request_body](docs/paths/request_body_post_ipv4_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv4_format_request_body](docs/paths/request_body_post_ipv4_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv4_format_request_body](docs/paths/request_body_post_ipv4_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv4_format_request_body](docs/paths/request_body_post_ipv4_format_request_body/post.md) | +/requestBody/postIpv6FormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ipv6_format_request_body](docs/paths/request_body_post_ipv6_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv6_format_request_body](docs/paths/request_body_post_ipv6_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv6_format_request_body](docs/paths/request_body_post_ipv6_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv6_format_request_body](docs/paths/request_body_post_ipv6_format_request_body/post.md) | +/requestBody/postJsonPointerFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_json_pointer_format_request_body](docs/paths/request_body_post_json_pointer_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_json_pointer_format_request_body](docs/paths/request_body_post_json_pointer_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_json_pointer_format_request_body](docs/paths/request_body_post_json_pointer_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_json_pointer_format_request_body](docs/paths/request_body_post_json_pointer_format_request_body/post.md) | +/requestBody/postMaximumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maximum_validation_request_body](docs/paths/request_body_post_maximum_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_request_body](docs/paths/request_body_post_maximum_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_request_body](docs/paths/request_body_post_maximum_validation_request_body/post.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_request_body](docs/paths/request_body_post_maximum_validation_request_body/post.md) | +/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_with_unsigned_integer_request_body](docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) | +/requestBody/postMaxitemsValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxitems_validation_request_body](docs/paths/request_body_post_maxitems_validation_request_body/post.md) [MaxItemsApi](docs/apis/tags/max_items_api.md).[post_maxitems_validation_request_body](docs/paths/request_body_post_maxitems_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxitems_validation_request_body](docs/paths/request_body_post_maxitems_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxitems_validation_request_body](docs/paths/request_body_post_maxitems_validation_request_body/post.md) | +/requestBody/postMaxlengthValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxlength_validation_request_body](docs/paths/request_body_post_maxlength_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxlength_validation_request_body](docs/paths/request_body_post_maxlength_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxlength_validation_request_body](docs/paths/request_body_post_maxlength_validation_request_body/post.md) [MaxLengthApi](docs/apis/tags/max_length_api.md).[post_maxlength_validation_request_body](docs/paths/request_body_post_maxlength_validation_request_body/post.md) | +/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties0_means_the_object_is_empty_request_body](docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) | +/requestBody/postMaxpropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_maxproperties_validation_request_body](docs/paths/request_body_post_maxproperties_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties_validation_request_body](docs/paths/request_body_post_maxproperties_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties_validation_request_body](docs/paths/request_body_post_maxproperties_validation_request_body/post.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties_validation_request_body](docs/paths/request_body_post_maxproperties_validation_request_body/post.md) | +/requestBody/postMinimumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minimum_validation_request_body](docs/paths/request_body_post_minimum_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_request_body](docs/paths/request_body_post_minimum_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_request_body](docs/paths/request_body_post_minimum_validation_request_body/post.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_request_body](docs/paths/request_body_post_minimum_validation_request_body/post.md) | +/requestBody/postMinimumValidationWithSignedIntegerRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_with_signed_integer_request_body](docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) | +/requestBody/postMinitemsValidationRequestBody **post** | [MinItemsApi](docs/apis/tags/min_items_api.md).[post_minitems_validation_request_body](docs/paths/request_body_post_minitems_validation_request_body/post.md) [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minitems_validation_request_body](docs/paths/request_body_post_minitems_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minitems_validation_request_body](docs/paths/request_body_post_minitems_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minitems_validation_request_body](docs/paths/request_body_post_minitems_validation_request_body/post.md) | +/requestBody/postMinlengthValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minlength_validation_request_body](docs/paths/request_body_post_minlength_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minlength_validation_request_body](docs/paths/request_body_post_minlength_validation_request_body/post.md) [MinLengthApi](docs/apis/tags/min_length_api.md).[post_minlength_validation_request_body](docs/paths/request_body_post_minlength_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minlength_validation_request_body](docs/paths/request_body_post_minlength_validation_request_body/post.md) | +/requestBody/postMinpropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_minproperties_validation_request_body](docs/paths/request_body_post_minproperties_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minproperties_validation_request_body](docs/paths/request_body_post_minproperties_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minproperties_validation_request_body](docs/paths/request_body_post_minproperties_validation_request_body/post.md) [MinPropertiesApi](docs/apis/tags/min_properties_api.md).[post_minproperties_validation_request_body](docs/paths/request_body_post_minproperties_validation_request_body/post.md) | +/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) [AllOfApi](docs/apis/tags/all_of_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_allof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) | +/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_nested_anyof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) | +/requestBody/postNestedItemsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_items_request_body](docs/paths/request_body_post_nested_items_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_items_request_body](docs/paths/request_body_post_nested_items_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_items_request_body](docs/paths/request_body_post_nested_items_request_body/post.md) [ItemsApi](docs/apis/tags/items_api.md).[post_nested_items_request_body](docs/paths/request_body_post_nested_items_request_body/post.md) | +/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_oneof_to_check_validation_semantics_request_body](docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) | +/requestBody/postNotMoreComplexSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_not_more_complex_schema_request_body](docs/paths/request_body_post_not_more_complex_schema_request_body/post.md) [_NotApi](docs/apis/tags/_not_api.md).[post_not_more_complex_schema_request_body](docs/paths/request_body_post_not_more_complex_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_more_complex_schema_request_body](docs/paths/request_body_post_not_more_complex_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_more_complex_schema_request_body](docs/paths/request_body_post_not_more_complex_schema_request_body/post.md) | +/requestBody/postNotRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_not_request_body](docs/paths/request_body_post_not_request_body/post.md) [_NotApi](docs/apis/tags/_not_api.md).[post_not_request_body](docs/paths/request_body_post_not_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_request_body](docs/paths/request_body_post_not_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_request_body](docs/paths/request_body_post_not_request_body/post.md) | +/requestBody/postNulCharactersInStringsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_nul_characters_in_strings_request_body](docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nul_characters_in_strings_request_body](docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nul_characters_in_strings_request_body](docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_nul_characters_in_strings_request_body](docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md) | +/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_null_type_matches_only_the_null_object_request_body](docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) | +/requestBody/postNumberTypeMatchesNumbersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_number_type_matches_numbers_request_body](docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_number_type_matches_numbers_request_body](docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_number_type_matches_numbers_request_body](docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_number_type_matches_numbers_request_body](docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md) | +/requestBody/postObjectPropertiesValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_object_properties_validation_request_body](docs/paths/request_body_post_object_properties_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_properties_validation_request_body](docs/paths/request_body_post_object_properties_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_properties_validation_request_body](docs/paths/request_body_post_object_properties_validation_request_body/post.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_object_properties_validation_request_body](docs/paths/request_body_post_object_properties_validation_request_body/post.md) | +/requestBody/postObjectTypeMatchesObjectsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_object_type_matches_objects_request_body](docs/paths/request_body_post_object_type_matches_objects_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_type_matches_objects_request_body](docs/paths/request_body_post_object_type_matches_objects_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_type_matches_objects_request_body](docs/paths/request_body_post_object_type_matches_objects_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_object_type_matches_objects_request_body](docs/paths/request_body_post_object_type_matches_objects_request_body/post.md) | +/requestBody/postOneofComplexTypesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_complex_types_request_body](docs/paths/request_body_post_oneof_complex_types_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_complex_types_request_body](docs/paths/request_body_post_oneof_complex_types_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_complex_types_request_body](docs/paths/request_body_post_oneof_complex_types_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_complex_types_request_body](docs/paths/request_body_post_oneof_complex_types_request_body/post.md) | +/requestBody/postOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_request_body](docs/paths/request_body_post_oneof_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_request_body](docs/paths/request_body_post_oneof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_request_body](docs/paths/request_body_post_oneof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_request_body](docs/paths/request_body_post_oneof_request_body/post.md) | +/requestBody/postOneofWithBaseSchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_base_schema_request_body](docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_base_schema_request_body](docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_base_schema_request_body](docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_base_schema_request_body](docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md) | +/requestBody/postOneofWithEmptySchemaRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_empty_schema_request_body](docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_empty_schema_request_body](docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_empty_schema_request_body](docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_empty_schema_request_body](docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md) | +/requestBody/postOneofWithRequiredRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_oneof_with_required_request_body](docs/paths/request_body_post_oneof_with_required_request_body/post.md) [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_required_request_body](docs/paths/request_body_post_oneof_with_required_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_required_request_body](docs/paths/request_body_post_oneof_with_required_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_required_request_body](docs/paths/request_body_post_oneof_with_required_request_body/post.md) | +/requestBody/postPatternIsNotAnchoredRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_pattern_is_not_anchored_request_body](docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_is_not_anchored_request_body](docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_is_not_anchored_request_body](docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_is_not_anchored_request_body](docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md) | +/requestBody/postPatternValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_pattern_validation_request_body](docs/paths/request_body_post_pattern_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_validation_request_body](docs/paths/request_body_post_pattern_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_validation_request_body](docs/paths/request_body_post_pattern_validation_request_body/post.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_validation_request_body](docs/paths/request_body_post_pattern_validation_request_body/post.md) | +/requestBody/postPropertiesWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_properties_with_escaped_characters_request_body](docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_properties_with_escaped_characters_request_body](docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_properties_with_escaped_characters_request_body](docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_properties_with_escaped_characters_request_body](docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md) | +/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_property_named_ref_that_is_not_a_reference_request_body](docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) | +/requestBody/postRefInAdditionalpropertiesRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_additionalproperties_request_body](docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_additionalproperties_request_body](docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_additionalproperties_request_body](docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_additionalproperties_request_body](docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md) | +/requestBody/postRefInAllofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_allof_request_body](docs/paths/request_body_post_ref_in_allof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_allof_request_body](docs/paths/request_body_post_ref_in_allof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_allof_request_body](docs/paths/request_body_post_ref_in_allof_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_allof_request_body](docs/paths/request_body_post_ref_in_allof_request_body/post.md) | +/requestBody/postRefInAnyofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_anyof_request_body](docs/paths/request_body_post_ref_in_anyof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_anyof_request_body](docs/paths/request_body_post_ref_in_anyof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_anyof_request_body](docs/paths/request_body_post_ref_in_anyof_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_anyof_request_body](docs/paths/request_body_post_ref_in_anyof_request_body/post.md) | +/requestBody/postRefInItemsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_items_request_body](docs/paths/request_body_post_ref_in_items_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_items_request_body](docs/paths/request_body_post_ref_in_items_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_items_request_body](docs/paths/request_body_post_ref_in_items_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_items_request_body](docs/paths/request_body_post_ref_in_items_request_body/post.md) | +/requestBody/postRefInNotRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_not_request_body](docs/paths/request_body_post_ref_in_not_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_not_request_body](docs/paths/request_body_post_ref_in_not_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_not_request_body](docs/paths/request_body_post_ref_in_not_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_not_request_body](docs/paths/request_body_post_ref_in_not_request_body/post.md) | +/requestBody/postRefInOneofRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_oneof_request_body](docs/paths/request_body_post_ref_in_oneof_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_oneof_request_body](docs/paths/request_body_post_ref_in_oneof_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_oneof_request_body](docs/paths/request_body_post_ref_in_oneof_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_oneof_request_body](docs/paths/request_body_post_ref_in_oneof_request_body/post.md) | +/requestBody/postRefInPropertyRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_ref_in_property_request_body](docs/paths/request_body_post_ref_in_property_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_property_request_body](docs/paths/request_body_post_ref_in_property_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_property_request_body](docs/paths/request_body_post_ref_in_property_request_body/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_property_request_body](docs/paths/request_body_post_ref_in_property_request_body/post.md) | +/requestBody/postRequiredDefaultValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_default_validation_request_body](docs/paths/request_body_post_required_default_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_default_validation_request_body](docs/paths/request_body_post_required_default_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_default_validation_request_body](docs/paths/request_body_post_required_default_validation_request_body/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_default_validation_request_body](docs/paths/request_body_post_required_default_validation_request_body/post.md) | +/requestBody/postRequiredValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_validation_request_body](docs/paths/request_body_post_required_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_validation_request_body](docs/paths/request_body_post_required_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_validation_request_body](docs/paths/request_body_post_required_validation_request_body/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_validation_request_body](docs/paths/request_body_post_required_validation_request_body/post.md) | +/requestBody/postRequiredWithEmptyArrayRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_with_empty_array_request_body](docs/paths/request_body_post_required_with_empty_array_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_empty_array_request_body](docs/paths/request_body_post_required_with_empty_array_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_empty_array_request_body](docs/paths/request_body_post_required_with_empty_array_request_body/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_empty_array_request_body](docs/paths/request_body_post_required_with_empty_array_request_body/post.md) | +/requestBody/postRequiredWithEscapedCharactersRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_required_with_escaped_characters_request_body](docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_escaped_characters_request_body](docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_escaped_characters_request_body](docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_escaped_characters_request_body](docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md) | +/requestBody/postSimpleEnumValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_simple_enum_validation_request_body](docs/paths/request_body_post_simple_enum_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_simple_enum_validation_request_body](docs/paths/request_body_post_simple_enum_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_simple_enum_validation_request_body](docs/paths/request_body_post_simple_enum_validation_request_body/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_simple_enum_validation_request_body](docs/paths/request_body_post_simple_enum_validation_request_body/post.md) | +/requestBody/postStringTypeMatchesStringsRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_string_type_matches_strings_request_body](docs/paths/request_body_post_string_type_matches_strings_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_string_type_matches_strings_request_body](docs/paths/request_body_post_string_type_matches_strings_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_string_type_matches_strings_request_body](docs/paths/request_body_post_string_type_matches_strings_request_body/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_string_type_matches_strings_request_body](docs/paths/request_body_post_string_type_matches_strings_request_body/post.md) | +/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) [DefaultApi](docs/apis/tags/default_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body](docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) | +/requestBody/postUniqueitemsFalseValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uniqueitems_false_validation_request_body](docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_false_validation_request_body](docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_false_validation_request_body](docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_false_validation_request_body](docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md) | +/requestBody/postUniqueitemsValidationRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uniqueitems_validation_request_body](docs/paths/request_body_post_uniqueitems_validation_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_validation_request_body](docs/paths/request_body_post_uniqueitems_validation_request_body/post.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_validation_request_body](docs/paths/request_body_post_uniqueitems_validation_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_validation_request_body](docs/paths/request_body_post_uniqueitems_validation_request_body/post.md) | +/requestBody/postUriFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_format_request_body](docs/paths/request_body_post_uri_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_format_request_body](docs/paths/request_body_post_uri_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_format_request_body](docs/paths/request_body_post_uri_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_format_request_body](docs/paths/request_body_post_uri_format_request_body/post.md) | +/requestBody/postUriReferenceFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_reference_format_request_body](docs/paths/request_body_post_uri_reference_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_reference_format_request_body](docs/paths/request_body_post_uri_reference_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_reference_format_request_body](docs/paths/request_body_post_uri_reference_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_reference_format_request_body](docs/paths/request_body_post_uri_reference_format_request_body/post.md) | +/requestBody/postUriTemplateFormatRequestBody **post** | [OperationRequestBodyApi](docs/apis/tags/operation_request_body_api.md).[post_uri_template_format_request_body](docs/paths/request_body_post_uri_template_format_request_body/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_template_format_request_body](docs/paths/request_body_post_uri_template_format_request_body/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_template_format_request_body](docs/paths/request_body_post_uri_template_format_request_body/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_template_format_request_body](docs/paths/request_body_post_uri_template_format_request_body/post.md) | +/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) | +/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_are_allowed_by_default_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) | +/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_can_exist_by_itself_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) | +/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) [AdditionalPropertiesApi](docs/apis/tags/additional_properties_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types](docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) | +/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_combined_with_anyof_oneof_response_body_for_content_types](docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) | +/responseBody/postAllofResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_response_body_for_content_types](docs/paths/response_body_post_allof_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_response_body_for_content_types](docs/paths/response_body_post_allof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_response_body_for_content_types](docs/paths/response_body_post_allof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_response_body_for_content_types](docs/paths/response_body_post_allof_response_body_for_content_types/post.md) | +/responseBody/postAllofSimpleTypesResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_simple_types_response_body_for_content_types](docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_simple_types_response_body_for_content_types](docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_simple_types_response_body_for_content_types](docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_simple_types_response_body_for_content_types](docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) | +/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) | +/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) | +/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_the_first_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) | +/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_the_last_empty_schema_response_body_for_content_types](docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) | +/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_allof_with_two_empty_schemas_response_body_for_content_types](docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) | +/responseBody/postAnyofComplexTypesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_complex_types_response_body_for_content_types](docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) | +/responseBody/postAnyofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_response_body_for_content_types](docs/paths/response_body_post_anyof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_response_body_for_content_types](docs/paths/response_body_post_anyof_response_body_for_content_types/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_response_body_for_content_types](docs/paths/response_body_post_anyof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_response_body_for_content_types](docs/paths/response_body_post_anyof_response_body_for_content_types/post.md) | +/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) | +/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_anyof_with_one_empty_schema_response_body_for_content_types](docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) | +/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_array_type_matches_arrays_response_body_for_content_types](docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) | +/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_boolean_type_matches_booleans_response_body_for_content_types](docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) | +/responseBody/postByIntResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_int_response_body_for_content_types](docs/paths/response_body_post_by_int_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_int_response_body_for_content_types](docs/paths/response_body_post_by_int_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_int_response_body_for_content_types](docs/paths/response_body_post_by_int_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_int_response_body_for_content_types](docs/paths/response_body_post_by_int_response_body_for_content_types/post.md) | +/responseBody/postByNumberResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_number_response_body_for_content_types](docs/paths/response_body_post_by_number_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_number_response_body_for_content_types](docs/paths/response_body_post_by_number_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_number_response_body_for_content_types](docs/paths/response_body_post_by_number_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_number_response_body_for_content_types](docs/paths/response_body_post_by_number_response_body_for_content_types/post.md) | +/responseBody/postBySmallNumberResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_by_small_number_response_body_for_content_types](docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_by_small_number_response_body_for_content_types](docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_by_small_number_response_body_for_content_types](docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_by_small_number_response_body_for_content_types](docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md) | +/responseBody/postDateTimeFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_date_time_format_response_body_for_content_types](docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_date_time_format_response_body_for_content_types](docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_date_time_format_response_body_for_content_types](docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_date_time_format_response_body_for_content_types](docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md) | +/responseBody/postEmailFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_email_format_response_body_for_content_types](docs/paths/response_body_post_email_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_email_format_response_body_for_content_types](docs/paths/response_body_post_email_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_email_format_response_body_for_content_types](docs/paths/response_body_post_email_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_email_format_response_body_for_content_types](docs/paths/response_body_post_email_format_response_body_for_content_types/post.md) | +/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with0_does_not_match_false_response_body_for_content_types](docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) | +/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with1_does_not_match_true_response_body_for_content_types](docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) | +/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) | +/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_false_does_not_match0_response_body_for_content_types](docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) | +/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enum_with_true_does_not_match1_response_body_for_content_types](docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) | +/responseBody/postEnumsInPropertiesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_enums_in_properties_response_body_for_content_types](docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_enums_in_properties_response_body_for_content_types](docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_enums_in_properties_response_body_for_content_types](docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_enums_in_properties_response_body_for_content_types](docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) | +/responseBody/postForbiddenPropertyResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_forbidden_property_response_body_for_content_types](docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_forbidden_property_response_body_for_content_types](docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_forbidden_property_response_body_for_content_types](docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_forbidden_property_response_body_for_content_types](docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) | +/responseBody/postHostnameFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_hostname_format_response_body_for_content_types](docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_hostname_format_response_body_for_content_types](docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_hostname_format_response_body_for_content_types](docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_hostname_format_response_body_for_content_types](docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md) | +/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_integer_type_matches_integers_response_body_for_content_types](docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) | +/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes **post** | [MultipleOfApi](docs/apis/tags/multiple_of_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types](docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) | +/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_invalid_string_value_for_default_response_body_for_content_types](docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) | +/responseBody/postIpv4FormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv4_format_response_body_for_content_types](docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv4_format_response_body_for_content_types](docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv4_format_response_body_for_content_types](docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ipv4_format_response_body_for_content_types](docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) | +/responseBody/postIpv6FormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ipv6_format_response_body_for_content_types](docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ipv6_format_response_body_for_content_types](docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_ipv6_format_response_body_for_content_types](docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ipv6_format_response_body_for_content_types](docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) | +/responseBody/postJsonPointerFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_json_pointer_format_response_body_for_content_types](docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_json_pointer_format_response_body_for_content_types](docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_json_pointer_format_response_body_for_content_types](docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_json_pointer_format_response_body_for_content_types](docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) | +/responseBody/postMaximumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maximum_validation_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) | +/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) [MaximumApi](docs/apis/tags/maximum_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maximum_validation_with_unsigned_integer_response_body_for_content_types](docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) | +/responseBody/postMaxitemsValidationResponseBodyForContentTypes **post** | [MaxItemsApi](docs/apis/tags/max_items_api.md).[post_maxitems_validation_response_body_for_content_types](docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxitems_validation_response_body_for_content_types](docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxitems_validation_response_body_for_content_types](docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxitems_validation_response_body_for_content_types](docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) | +/responseBody/postMaxlengthValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxlength_validation_response_body_for_content_types](docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxlength_validation_response_body_for_content_types](docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxlength_validation_response_body_for_content_types](docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) [MaxLengthApi](docs/apis/tags/max_length_api.md).[post_maxlength_validation_response_body_for_content_types](docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) | +/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxproperties0_means_the_object_is_empty_response_body_for_content_types](docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) | +/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) [MaxPropertiesApi](docs/apis/tags/max_properties_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_maxproperties_validation_response_body_for_content_types](docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) | +/responseBody/postMinimumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minimum_validation_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) | +/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) [MinimumApi](docs/apis/tags/minimum_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minimum_validation_with_signed_integer_response_body_for_content_types](docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) | +/responseBody/postMinitemsValidationResponseBodyForContentTypes **post** | [MinItemsApi](docs/apis/tags/min_items_api.md).[post_minitems_validation_response_body_for_content_types](docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_minitems_validation_response_body_for_content_types](docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minitems_validation_response_body_for_content_types](docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minitems_validation_response_body_for_content_types](docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) | +/responseBody/postMinlengthValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minlength_validation_response_body_for_content_types](docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) [MinLengthApi](docs/apis/tags/min_length_api.md).[post_minlength_validation_response_body_for_content_types](docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minlength_validation_response_body_for_content_types](docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minlength_validation_response_body_for_content_types](docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) | +/responseBody/postMinpropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_minproperties_validation_response_body_for_content_types](docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_minproperties_validation_response_body_for_content_types](docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_minproperties_validation_response_body_for_content_types](docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) [MinPropertiesApi](docs/apis/tags/min_properties_api.md).[post_minproperties_validation_response_body_for_content_types](docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) | +/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [AllOfApi](docs/apis/tags/all_of_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_allof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) | +/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) [AnyOfApi](docs/apis/tags/any_of_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_anyof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) | +/responseBody/postNestedItemsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_items_response_body_for_content_types](docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_items_response_body_for_content_types](docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md) [ItemsApi](docs/apis/tags/items_api.md).[post_nested_items_response_body_for_content_types](docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_items_response_body_for_content_types](docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md) | +/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nested_oneof_to_check_validation_semantics_response_body_for_content_types](docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) | +/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_not_more_complex_schema_response_body_for_content_types](docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) | +/responseBody/postNotResponseBodyForContentTypes **post** | [_NotApi](docs/apis/tags/_not_api.md).[post_not_response_body_for_content_types](docs/paths/response_body_post_not_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_not_response_body_for_content_types](docs/paths/response_body_post_not_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_not_response_body_for_content_types](docs/paths/response_body_post_not_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_not_response_body_for_content_types](docs/paths/response_body_post_not_response_body_for_content_types/post.md) | +/responseBody/postNulCharactersInStringsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_nul_characters_in_strings_response_body_for_content_types](docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) | +/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_null_type_matches_only_the_null_object_response_body_for_content_types](docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) | +/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_number_type_matches_numbers_response_body_for_content_types](docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) | +/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_properties_validation_response_body_for_content_types](docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_properties_validation_response_body_for_content_types](docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_object_properties_validation_response_body_for_content_types](docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_object_properties_validation_response_body_for_content_types](docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) | +/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_object_type_matches_objects_response_body_for_content_types](docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) | +/responseBody/postOneofComplexTypesResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_complex_types_response_body_for_content_types](docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) | +/responseBody/postOneofResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_response_body_for_content_types](docs/paths/response_body_post_oneof_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_response_body_for_content_types](docs/paths/response_body_post_oneof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_response_body_for_content_types](docs/paths/response_body_post_oneof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_response_body_for_content_types](docs/paths/response_body_post_oneof_response_body_for_content_types/post.md) | +/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_base_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) | +/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_empty_schema_response_body_for_content_types](docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) | +/responseBody/postOneofWithRequiredResponseBodyForContentTypes **post** | [OneOfApi](docs/apis/tags/one_of_api.md).[post_oneof_with_required_response_body_for_content_types](docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_oneof_with_required_response_body_for_content_types](docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_oneof_with_required_response_body_for_content_types](docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_oneof_with_required_response_body_for_content_types](docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) | +/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_pattern_is_not_anchored_response_body_for_content_types](docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) | +/responseBody/postPatternValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_pattern_validation_response_body_for_content_types](docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_pattern_validation_response_body_for_content_types](docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) [PatternApi](docs/apis/tags/pattern_api.md).[post_pattern_validation_response_body_for_content_types](docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_pattern_validation_response_body_for_content_types](docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) | +/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) [PropertiesApi](docs/apis/tags/properties_api.md).[post_properties_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) | +/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_property_named_ref_that_is_not_a_reference_response_body_for_content_types](docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) | +/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_additionalproperties_response_body_for_content_types](docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) | +/responseBody/postRefInAllofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_allof_response_body_for_content_types](docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_allof_response_body_for_content_types](docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_allof_response_body_for_content_types](docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_allof_response_body_for_content_types](docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) | +/responseBody/postRefInAnyofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_anyof_response_body_for_content_types](docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) | +/responseBody/postRefInItemsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_items_response_body_for_content_types](docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_items_response_body_for_content_types](docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_items_response_body_for_content_types](docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_items_response_body_for_content_types](docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) | +/responseBody/postRefInNotResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_not_response_body_for_content_types](docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_not_response_body_for_content_types](docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_not_response_body_for_content_types](docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_not_response_body_for_content_types](docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) | +/responseBody/postRefInOneofResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_oneof_response_body_for_content_types](docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) | +/responseBody/postRefInPropertyResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_ref_in_property_response_body_for_content_types](docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_ref_in_property_response_body_for_content_types](docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) [RefApi](docs/apis/tags/ref_api.md).[post_ref_in_property_response_body_for_content_types](docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_ref_in_property_response_body_for_content_types](docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) | +/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_default_validation_response_body_for_content_types](docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_default_validation_response_body_for_content_types](docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_default_validation_response_body_for_content_types](docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_default_validation_response_body_for_content_types](docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) | +/responseBody/postRequiredValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_validation_response_body_for_content_types](docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_validation_response_body_for_content_types](docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_validation_response_body_for_content_types](docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_validation_response_body_for_content_types](docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md) | +/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_empty_array_response_body_for_content_types](docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) | +/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) [RequiredApi](docs/apis/tags/required_api.md).[post_required_with_escaped_characters_response_body_for_content_types](docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) | +/responseBody/postSimpleEnumValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) [EnumApi](docs/apis/tags/enum_api.md).[post_simple_enum_validation_response_body_for_content_types](docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) | +/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) [TypeApi](docs/apis/tags/type_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_string_type_matches_strings_response_body_for_content_types](docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) | +/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) [PathPostApi](docs/apis/tags/path_post_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types](docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) | +/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uniqueitems_false_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) | +/responseBody/postUniqueitemsValidationResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) [UniqueItemsApi](docs/apis/tags/unique_items_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uniqueitems_validation_response_body_for_content_types](docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) | +/responseBody/postUriFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_format_response_body_for_content_types](docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_format_response_body_for_content_types](docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_format_response_body_for_content_types](docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_format_response_body_for_content_types](docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md) | +/responseBody/postUriReferenceFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_reference_format_response_body_for_content_types](docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_reference_format_response_body_for_content_types](docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_reference_format_response_body_for_content_types](docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_reference_format_response_body_for_content_types](docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) | +/responseBody/postUriTemplateFormatResponseBodyForContentTypes **post** | [PathPostApi](docs/apis/tags/path_post_api.md).[post_uri_template_format_response_body_for_content_types](docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) [ContentTypeJsonApi](docs/apis/tags/content_type_json_api.md).[post_uri_template_format_response_body_for_content_types](docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) [FormatApi](docs/apis/tags/format_api.md).[post_uri_template_format_response_body_for_content_types](docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) [ResponseContentContentTypeSchemaApi](docs/apis/tags/response_content_content_type_schema_api.md).[post_uri_template_format_response_body_for_content_types](docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) | ## Component Schemas diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api.md index eb835bdca9b..0ba33ace170 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api.md @@ -9,11 +9,11 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_forbidden_property_request_body**](_not_api/post_forbidden_property_request_body.md) | -[**post_forbidden_property_response_body_for_content_types**](_not_api/post_forbidden_property_response_body_for_content_types.md) | -[**post_not_more_complex_schema_request_body**](_not_api/post_not_more_complex_schema_request_body.md) | -[**post_not_more_complex_schema_response_body_for_content_types**](_not_api/post_not_more_complex_schema_response_body_for_content_types.md) | -[**post_not_request_body**](_not_api/post_not_request_body.md) | -[**post_not_response_body_for_content_types**](_not_api/post_not_response_body_for_content_types.md) | +[**post_forbidden_property_request_body**](../../paths/request_body_post_forbidden_property_request_body/post.md) | +[**post_forbidden_property_response_body_for_content_types**](../../paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) | +[**post_not_more_complex_schema_request_body**](../../paths/request_body_post_not_more_complex_schema_request_body/post.md) | +[**post_not_more_complex_schema_response_body_for_content_types**](../../paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) | +[**post_not_request_body**](../../paths/request_body_post_not_request_body/post.md) | +[**post_not_response_body_for_content_types**](../../paths/response_body_post_not_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_request_body.md deleted file mode 100644 index 709359699c4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_forbidden_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postForbiddenPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example passing only required values which don't have defaults set - body = forbidden_property.ForbiddenProperty(None) - try: - api_response = api_instance.post_forbidden_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_forbidden_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_response_body_for_content_types.md deleted file mode 100644 index 809d494a59e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_forbidden_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_forbidden_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postForbiddenPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_forbidden_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_forbidden_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_request_body.md deleted file mode 100644 index 854eb377af2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_more_complex_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotMoreComplexSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example passing only required values which don't have defaults set - body = not_more_complex_schema.NotMoreComplexSchema(None) - try: - api_response = api_instance.post_not_more_complex_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_not_more_complex_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_response_body_for_content_types.md deleted file mode 100644 index 0d2aa927435..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_more_complex_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_more_complex_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_more_complex_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_not_more_complex_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_request_body.md deleted file mode 100644 index d44ce47a1e4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example passing only required values which don't have defaults set - body = _not._Not(None) - try: - api_response = api_instance.post_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_response_body_for_content_types.md deleted file mode 100644 index 1da272d273b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/_not_api/post_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import _not_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = _not_api._NotApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling _NotApi->post_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../_not_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api.md index 4ba6c1a4976..397fce370e0 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api.md @@ -9,13 +9,13 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) | -[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) | -[**post_additionalproperties_are_allowed_by_default_request_body**](additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md) | -[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) | -[**post_additionalproperties_can_exist_by_itself_request_body**](additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md) | -[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) | -[**post_additionalproperties_should_not_look_in_applicators_request_body**](additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) | -[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](../../paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) | +[**post_additionalproperties_are_allowed_by_default_request_body**](../../paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) | +[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) | +[**post_additionalproperties_can_exist_by_itself_request_body**](../../paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) | +[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_request_body**](../../paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md deleted file mode 100644 index 0a6456f663f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidate( - foo=None, - bar=None, - ) - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_allows_a_schema_which_should_validate_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md deleted file mode 100644 index ffd177aeaec..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md deleted file mode 100644 index 782b400e8dd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_are_allowed_by_default.AdditionalpropertiesAreAllowedByDefault(None) - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_are_allowed_by_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md deleted file mode 100644 index 395ed94bdb0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_are_allowed_by_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md deleted file mode 100644 index 29defdc0b61..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_can_exist_by_itself.AdditionalpropertiesCanExistByItself( - key=True, - ) - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_can_exist_by_itself_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md deleted file mode 100644 index bec47e21b86..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_can_exist_by_itself_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md deleted file mode 100644 index e45b56d1be7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_should_not_look_in_applicators.AdditionalpropertiesShouldNotLookInApplicators(None) - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_should_not_look_in_applicators_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md deleted file mode 100644 index d30f19ac2e0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/additional_properties_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import additional_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = additional_properties_api.AdditionalPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AdditionalPropertiesApi->post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../additional_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api.md index 604d499eb19..a8fc70cc41f 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api.md @@ -9,23 +9,23 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_allof_combined_with_anyof_oneof_request_body**](all_of_api/post_allof_combined_with_anyof_oneof_request_body.md) | -[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) | -[**post_allof_request_body**](all_of_api/post_allof_request_body.md) | -[**post_allof_response_body_for_content_types**](all_of_api/post_allof_response_body_for_content_types.md) | -[**post_allof_simple_types_request_body**](all_of_api/post_allof_simple_types_request_body.md) | -[**post_allof_simple_types_response_body_for_content_types**](all_of_api/post_allof_simple_types_response_body_for_content_types.md) | -[**post_allof_with_base_schema_request_body**](all_of_api/post_allof_with_base_schema_request_body.md) | -[**post_allof_with_base_schema_response_body_for_content_types**](all_of_api/post_allof_with_base_schema_response_body_for_content_types.md) | -[**post_allof_with_one_empty_schema_request_body**](all_of_api/post_allof_with_one_empty_schema_request_body.md) | -[**post_allof_with_one_empty_schema_response_body_for_content_types**](all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_first_empty_schema_request_body**](all_of_api/post_allof_with_the_first_empty_schema_request_body.md) | -[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_last_empty_schema_request_body**](all_of_api/post_allof_with_the_last_empty_schema_request_body.md) | -[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_two_empty_schemas_request_body**](all_of_api/post_allof_with_two_empty_schemas_request_body.md) | -[**post_allof_with_two_empty_schemas_response_body_for_content_types**](all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) | -[**post_nested_allof_to_check_validation_semantics_request_body**](all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md) | -[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) | +[**post_allof_combined_with_anyof_oneof_request_body**](../../paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) | +[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](../../paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) | +[**post_allof_request_body**](../../paths/request_body_post_allof_request_body/post.md) | +[**post_allof_response_body_for_content_types**](../../paths/response_body_post_allof_response_body_for_content_types/post.md) | +[**post_allof_simple_types_request_body**](../../paths/request_body_post_allof_simple_types_request_body/post.md) | +[**post_allof_simple_types_response_body_for_content_types**](../../paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) | +[**post_allof_with_base_schema_request_body**](../../paths/request_body_post_allof_with_base_schema_request_body/post.md) | +[**post_allof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) | +[**post_allof_with_one_empty_schema_request_body**](../../paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) | +[**post_allof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_first_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) | +[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_last_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) | +[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_two_empty_schemas_request_body**](../../paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) | +[**post_allof_with_two_empty_schemas_response_body_for_content_types**](../../paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) | +[**post_nested_allof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_request_body.md deleted file mode 100644 index ce052060d8f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofCombinedWithAnyofOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_combined_with_anyof_oneof.AllofCombinedWithAnyofOneof(None) - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_combined_with_anyof_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md deleted file mode 100644 index 19fc2d4dfc5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_combined_with_anyof_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_request_body.md deleted file mode 100644 index 97ec387f346..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof.Allof(None) - try: - api_response = api_instance.post_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_response_body_for_content_types.md deleted file mode 100644 index c25c33a500d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_request_body.md deleted file mode 100644 index 833d63133a8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_simple_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofSimpleTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_simple_types.AllofSimpleTypes(None) - try: - api_response = api_instance.post_allof_simple_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_simple_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_response_body_for_content_types.md deleted file mode 100644 index 617f97dbed7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_simple_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_simple_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofSimpleTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_simple_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_simple_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_request_body.md deleted file mode 100644 index 3e28226262e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_base_schema.AllofWithBaseSchema({}) - try: - api_response = api_instance.post_allof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index f6bafeac7a1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_request_body.md deleted file mode 100644 index 2b519b1c6d0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_one_empty_schema.AllofWithOneEmptySchema(None) - try: - api_response = api_instance.post_allof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index da9cd95f0c6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_request_body.md deleted file mode 100644 index 569e245b96c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheFirstEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_first_empty_schema.AllofWithTheFirstEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_the_first_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 26423ec1e54..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_the_first_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_request_body.md deleted file mode 100644 index 9350f01e48f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheLastEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_last_empty_schema.AllofWithTheLastEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_the_last_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 46f99e1b70c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_the_last_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_request_body.md deleted file mode 100644 index f5f6808c800..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_two_empty_schemas_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTwoEmptySchemasRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_two_empty_schemas.AllofWithTwoEmptySchemas(None) - try: - api_response = api_instance.post_allof_with_two_empty_schemas_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_two_empty_schemas_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md deleted file mode 100644 index 10e1008f540..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_two_empty_schemas_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_two_empty_schemas_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_allof_with_two_empty_schemas_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 2dcdc73fc56..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_allof_to_check_validation_semantics.NestedAllofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_nested_allof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 5ccadbf278b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/all_of_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import all_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = all_of_api.AllOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AllOfApi->post_nested_allof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../all_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api.md index 57aed6d389e..db24138c8f9 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api.md @@ -9,15 +9,15 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_anyof_complex_types_request_body**](any_of_api/post_anyof_complex_types_request_body.md) | -[**post_anyof_complex_types_response_body_for_content_types**](any_of_api/post_anyof_complex_types_response_body_for_content_types.md) | -[**post_anyof_request_body**](any_of_api/post_anyof_request_body.md) | -[**post_anyof_response_body_for_content_types**](any_of_api/post_anyof_response_body_for_content_types.md) | -[**post_anyof_with_base_schema_request_body**](any_of_api/post_anyof_with_base_schema_request_body.md) | -[**post_anyof_with_base_schema_response_body_for_content_types**](any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md) | -[**post_anyof_with_one_empty_schema_request_body**](any_of_api/post_anyof_with_one_empty_schema_request_body.md) | -[**post_anyof_with_one_empty_schema_response_body_for_content_types**](any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_nested_anyof_to_check_validation_semantics_request_body**](any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md) | -[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) | +[**post_anyof_complex_types_request_body**](../../paths/request_body_post_anyof_complex_types_request_body/post.md) | +[**post_anyof_complex_types_response_body_for_content_types**](../../paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) | +[**post_anyof_request_body**](../../paths/request_body_post_anyof_request_body/post.md) | +[**post_anyof_response_body_for_content_types**](../../paths/response_body_post_anyof_response_body_for_content_types/post.md) | +[**post_anyof_with_base_schema_request_body**](../../paths/request_body_post_anyof_with_base_schema_request_body/post.md) | +[**post_anyof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) | +[**post_anyof_with_one_empty_schema_request_body**](../../paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) | +[**post_anyof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_nested_anyof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_request_body.md deleted file mode 100644 index bc93d82d100..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_complex_types.AnyofComplexTypes(None) - try: - api_response = api_instance.post_anyof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_response_body_for_content_types.md deleted file mode 100644 index aaadbf713d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_request_body.md deleted file mode 100644 index e9f53d4e6e7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof.Anyof(None) - try: - api_response = api_instance.post_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_response_body_for_content_types.md deleted file mode 100644 index 052b05066d7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_request_body.md deleted file mode 100644 index 6970002d8d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_base_schema.AnyofWithBaseSchema("string_example") - try: - api_response = api_instance.post_anyof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 56264594311..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_request_body.md deleted file mode 100644 index 83771916f40..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_one_empty_schema.AnyofWithOneEmptySchema(None) - try: - api_response = api_instance.post_anyof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 535b41437d9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_anyof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 32ce7672f15..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_anyof_to_check_validation_semantics.NestedAnyofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_nested_anyof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 16524757744..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/any_of_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import any_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = any_of_api.AnyOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling AnyOfApi->post_nested_anyof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../any_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api.md index 1075ccd13ee..04d4743de09 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api.md @@ -9,179 +9,179 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) | -[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) | -[**post_additionalproperties_are_allowed_by_default_request_body**](content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md) | -[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) | -[**post_additionalproperties_can_exist_by_itself_request_body**](content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md) | -[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) | -[**post_additionalproperties_should_not_look_in_applicators_request_body**](content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) | -[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) | -[**post_allof_combined_with_anyof_oneof_request_body**](content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md) | -[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) | -[**post_allof_request_body**](content_type_json_api/post_allof_request_body.md) | -[**post_allof_response_body_for_content_types**](content_type_json_api/post_allof_response_body_for_content_types.md) | -[**post_allof_simple_types_request_body**](content_type_json_api/post_allof_simple_types_request_body.md) | -[**post_allof_simple_types_response_body_for_content_types**](content_type_json_api/post_allof_simple_types_response_body_for_content_types.md) | -[**post_allof_with_base_schema_request_body**](content_type_json_api/post_allof_with_base_schema_request_body.md) | -[**post_allof_with_base_schema_response_body_for_content_types**](content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md) | -[**post_allof_with_one_empty_schema_request_body**](content_type_json_api/post_allof_with_one_empty_schema_request_body.md) | -[**post_allof_with_one_empty_schema_response_body_for_content_types**](content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_first_empty_schema_request_body**](content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md) | -[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_last_empty_schema_request_body**](content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md) | -[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_two_empty_schemas_request_body**](content_type_json_api/post_allof_with_two_empty_schemas_request_body.md) | -[**post_allof_with_two_empty_schemas_response_body_for_content_types**](content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) | -[**post_anyof_complex_types_request_body**](content_type_json_api/post_anyof_complex_types_request_body.md) | -[**post_anyof_complex_types_response_body_for_content_types**](content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md) | -[**post_anyof_request_body**](content_type_json_api/post_anyof_request_body.md) | -[**post_anyof_response_body_for_content_types**](content_type_json_api/post_anyof_response_body_for_content_types.md) | -[**post_anyof_with_base_schema_request_body**](content_type_json_api/post_anyof_with_base_schema_request_body.md) | -[**post_anyof_with_base_schema_response_body_for_content_types**](content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md) | -[**post_anyof_with_one_empty_schema_request_body**](content_type_json_api/post_anyof_with_one_empty_schema_request_body.md) | -[**post_anyof_with_one_empty_schema_response_body_for_content_types**](content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_array_type_matches_arrays_request_body**](content_type_json_api/post_array_type_matches_arrays_request_body.md) | -[**post_array_type_matches_arrays_response_body_for_content_types**](content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md) | -[**post_boolean_type_matches_booleans_request_body**](content_type_json_api/post_boolean_type_matches_booleans_request_body.md) | -[**post_boolean_type_matches_booleans_response_body_for_content_types**](content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) | -[**post_by_int_request_body**](content_type_json_api/post_by_int_request_body.md) | -[**post_by_int_response_body_for_content_types**](content_type_json_api/post_by_int_response_body_for_content_types.md) | -[**post_by_number_request_body**](content_type_json_api/post_by_number_request_body.md) | -[**post_by_number_response_body_for_content_types**](content_type_json_api/post_by_number_response_body_for_content_types.md) | -[**post_by_small_number_request_body**](content_type_json_api/post_by_small_number_request_body.md) | -[**post_by_small_number_response_body_for_content_types**](content_type_json_api/post_by_small_number_response_body_for_content_types.md) | -[**post_date_time_format_request_body**](content_type_json_api/post_date_time_format_request_body.md) | -[**post_date_time_format_response_body_for_content_types**](content_type_json_api/post_date_time_format_response_body_for_content_types.md) | -[**post_email_format_request_body**](content_type_json_api/post_email_format_request_body.md) | -[**post_email_format_response_body_for_content_types**](content_type_json_api/post_email_format_response_body_for_content_types.md) | -[**post_enum_with0_does_not_match_false_request_body**](content_type_json_api/post_enum_with0_does_not_match_false_request_body.md) | -[**post_enum_with0_does_not_match_false_response_body_for_content_types**](content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) | -[**post_enum_with1_does_not_match_true_request_body**](content_type_json_api/post_enum_with1_does_not_match_true_request_body.md) | -[**post_enum_with1_does_not_match_true_response_body_for_content_types**](content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) | -[**post_enum_with_escaped_characters_request_body**](content_type_json_api/post_enum_with_escaped_characters_request_body.md) | -[**post_enum_with_escaped_characters_response_body_for_content_types**](content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md) | -[**post_enum_with_false_does_not_match0_request_body**](content_type_json_api/post_enum_with_false_does_not_match0_request_body.md) | -[**post_enum_with_false_does_not_match0_response_body_for_content_types**](content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) | -[**post_enum_with_true_does_not_match1_request_body**](content_type_json_api/post_enum_with_true_does_not_match1_request_body.md) | -[**post_enum_with_true_does_not_match1_response_body_for_content_types**](content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) | -[**post_enums_in_properties_request_body**](content_type_json_api/post_enums_in_properties_request_body.md) | -[**post_enums_in_properties_response_body_for_content_types**](content_type_json_api/post_enums_in_properties_response_body_for_content_types.md) | -[**post_forbidden_property_request_body**](content_type_json_api/post_forbidden_property_request_body.md) | -[**post_forbidden_property_response_body_for_content_types**](content_type_json_api/post_forbidden_property_response_body_for_content_types.md) | -[**post_hostname_format_request_body**](content_type_json_api/post_hostname_format_request_body.md) | -[**post_hostname_format_response_body_for_content_types**](content_type_json_api/post_hostname_format_response_body_for_content_types.md) | -[**post_integer_type_matches_integers_request_body**](content_type_json_api/post_integer_type_matches_integers_request_body.md) | -[**post_integer_type_matches_integers_response_body_for_content_types**](content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) | -[**post_invalid_string_value_for_default_request_body**](content_type_json_api/post_invalid_string_value_for_default_request_body.md) | -[**post_invalid_string_value_for_default_response_body_for_content_types**](content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md) | -[**post_ipv4_format_request_body**](content_type_json_api/post_ipv4_format_request_body.md) | -[**post_ipv4_format_response_body_for_content_types**](content_type_json_api/post_ipv4_format_response_body_for_content_types.md) | -[**post_ipv6_format_request_body**](content_type_json_api/post_ipv6_format_request_body.md) | -[**post_ipv6_format_response_body_for_content_types**](content_type_json_api/post_ipv6_format_response_body_for_content_types.md) | -[**post_json_pointer_format_request_body**](content_type_json_api/post_json_pointer_format_request_body.md) | -[**post_json_pointer_format_response_body_for_content_types**](content_type_json_api/post_json_pointer_format_response_body_for_content_types.md) | -[**post_maximum_validation_request_body**](content_type_json_api/post_maximum_validation_request_body.md) | -[**post_maximum_validation_response_body_for_content_types**](content_type_json_api/post_maximum_validation_response_body_for_content_types.md) | -[**post_maximum_validation_with_unsigned_integer_request_body**](content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md) | -[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) | -[**post_maxitems_validation_request_body**](content_type_json_api/post_maxitems_validation_request_body.md) | -[**post_maxitems_validation_response_body_for_content_types**](content_type_json_api/post_maxitems_validation_response_body_for_content_types.md) | -[**post_maxlength_validation_request_body**](content_type_json_api/post_maxlength_validation_request_body.md) | -[**post_maxlength_validation_response_body_for_content_types**](content_type_json_api/post_maxlength_validation_response_body_for_content_types.md) | -[**post_maxproperties0_means_the_object_is_empty_request_body**](content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md) | -[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) | -[**post_maxproperties_validation_request_body**](content_type_json_api/post_maxproperties_validation_request_body.md) | -[**post_maxproperties_validation_response_body_for_content_types**](content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md) | -[**post_minimum_validation_request_body**](content_type_json_api/post_minimum_validation_request_body.md) | -[**post_minimum_validation_response_body_for_content_types**](content_type_json_api/post_minimum_validation_response_body_for_content_types.md) | -[**post_minimum_validation_with_signed_integer_request_body**](content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md) | -[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) | -[**post_minitems_validation_request_body**](content_type_json_api/post_minitems_validation_request_body.md) | -[**post_minitems_validation_response_body_for_content_types**](content_type_json_api/post_minitems_validation_response_body_for_content_types.md) | -[**post_minlength_validation_request_body**](content_type_json_api/post_minlength_validation_request_body.md) | -[**post_minlength_validation_response_body_for_content_types**](content_type_json_api/post_minlength_validation_response_body_for_content_types.md) | -[**post_minproperties_validation_request_body**](content_type_json_api/post_minproperties_validation_request_body.md) | -[**post_minproperties_validation_response_body_for_content_types**](content_type_json_api/post_minproperties_validation_response_body_for_content_types.md) | -[**post_nested_allof_to_check_validation_semantics_request_body**](content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md) | -[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_anyof_to_check_validation_semantics_request_body**](content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md) | -[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_items_request_body**](content_type_json_api/post_nested_items_request_body.md) | -[**post_nested_items_response_body_for_content_types**](content_type_json_api/post_nested_items_response_body_for_content_types.md) | -[**post_nested_oneof_to_check_validation_semantics_request_body**](content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md) | -[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_not_more_complex_schema_request_body**](content_type_json_api/post_not_more_complex_schema_request_body.md) | -[**post_not_more_complex_schema_response_body_for_content_types**](content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md) | -[**post_not_request_body**](content_type_json_api/post_not_request_body.md) | -[**post_not_response_body_for_content_types**](content_type_json_api/post_not_response_body_for_content_types.md) | -[**post_nul_characters_in_strings_request_body**](content_type_json_api/post_nul_characters_in_strings_request_body.md) | -[**post_nul_characters_in_strings_response_body_for_content_types**](content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md) | -[**post_null_type_matches_only_the_null_object_request_body**](content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md) | -[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) | -[**post_number_type_matches_numbers_request_body**](content_type_json_api/post_number_type_matches_numbers_request_body.md) | -[**post_number_type_matches_numbers_response_body_for_content_types**](content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md) | -[**post_object_properties_validation_request_body**](content_type_json_api/post_object_properties_validation_request_body.md) | -[**post_object_properties_validation_response_body_for_content_types**](content_type_json_api/post_object_properties_validation_response_body_for_content_types.md) | -[**post_object_type_matches_objects_request_body**](content_type_json_api/post_object_type_matches_objects_request_body.md) | -[**post_object_type_matches_objects_response_body_for_content_types**](content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md) | -[**post_oneof_complex_types_request_body**](content_type_json_api/post_oneof_complex_types_request_body.md) | -[**post_oneof_complex_types_response_body_for_content_types**](content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md) | -[**post_oneof_request_body**](content_type_json_api/post_oneof_request_body.md) | -[**post_oneof_response_body_for_content_types**](content_type_json_api/post_oneof_response_body_for_content_types.md) | -[**post_oneof_with_base_schema_request_body**](content_type_json_api/post_oneof_with_base_schema_request_body.md) | -[**post_oneof_with_base_schema_response_body_for_content_types**](content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md) | -[**post_oneof_with_empty_schema_request_body**](content_type_json_api/post_oneof_with_empty_schema_request_body.md) | -[**post_oneof_with_empty_schema_response_body_for_content_types**](content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md) | -[**post_oneof_with_required_request_body**](content_type_json_api/post_oneof_with_required_request_body.md) | -[**post_oneof_with_required_response_body_for_content_types**](content_type_json_api/post_oneof_with_required_response_body_for_content_types.md) | -[**post_pattern_is_not_anchored_request_body**](content_type_json_api/post_pattern_is_not_anchored_request_body.md) | -[**post_pattern_is_not_anchored_response_body_for_content_types**](content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md) | -[**post_pattern_validation_request_body**](content_type_json_api/post_pattern_validation_request_body.md) | -[**post_pattern_validation_response_body_for_content_types**](content_type_json_api/post_pattern_validation_response_body_for_content_types.md) | -[**post_properties_with_escaped_characters_request_body**](content_type_json_api/post_properties_with_escaped_characters_request_body.md) | -[**post_properties_with_escaped_characters_response_body_for_content_types**](content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md) | -[**post_property_named_ref_that_is_not_a_reference_request_body**](content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md) | -[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) | -[**post_ref_in_additionalproperties_request_body**](content_type_json_api/post_ref_in_additionalproperties_request_body.md) | -[**post_ref_in_additionalproperties_response_body_for_content_types**](content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md) | -[**post_ref_in_allof_request_body**](content_type_json_api/post_ref_in_allof_request_body.md) | -[**post_ref_in_allof_response_body_for_content_types**](content_type_json_api/post_ref_in_allof_response_body_for_content_types.md) | -[**post_ref_in_anyof_request_body**](content_type_json_api/post_ref_in_anyof_request_body.md) | -[**post_ref_in_anyof_response_body_for_content_types**](content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md) | -[**post_ref_in_items_request_body**](content_type_json_api/post_ref_in_items_request_body.md) | -[**post_ref_in_items_response_body_for_content_types**](content_type_json_api/post_ref_in_items_response_body_for_content_types.md) | -[**post_ref_in_not_request_body**](content_type_json_api/post_ref_in_not_request_body.md) | -[**post_ref_in_not_response_body_for_content_types**](content_type_json_api/post_ref_in_not_response_body_for_content_types.md) | -[**post_ref_in_oneof_request_body**](content_type_json_api/post_ref_in_oneof_request_body.md) | -[**post_ref_in_oneof_response_body_for_content_types**](content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md) | -[**post_ref_in_property_request_body**](content_type_json_api/post_ref_in_property_request_body.md) | -[**post_ref_in_property_response_body_for_content_types**](content_type_json_api/post_ref_in_property_response_body_for_content_types.md) | -[**post_required_default_validation_request_body**](content_type_json_api/post_required_default_validation_request_body.md) | -[**post_required_default_validation_response_body_for_content_types**](content_type_json_api/post_required_default_validation_response_body_for_content_types.md) | -[**post_required_validation_request_body**](content_type_json_api/post_required_validation_request_body.md) | -[**post_required_validation_response_body_for_content_types**](content_type_json_api/post_required_validation_response_body_for_content_types.md) | -[**post_required_with_empty_array_request_body**](content_type_json_api/post_required_with_empty_array_request_body.md) | -[**post_required_with_empty_array_response_body_for_content_types**](content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md) | -[**post_required_with_escaped_characters_request_body**](content_type_json_api/post_required_with_escaped_characters_request_body.md) | -[**post_required_with_escaped_characters_response_body_for_content_types**](content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md) | -[**post_simple_enum_validation_request_body**](content_type_json_api/post_simple_enum_validation_request_body.md) | -[**post_simple_enum_validation_response_body_for_content_types**](content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md) | -[**post_string_type_matches_strings_request_body**](content_type_json_api/post_string_type_matches_strings_request_body.md) | -[**post_string_type_matches_strings_response_body_for_content_types**](content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) | -[**post_uniqueitems_false_validation_request_body**](content_type_json_api/post_uniqueitems_false_validation_request_body.md) | -[**post_uniqueitems_false_validation_response_body_for_content_types**](content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md) | -[**post_uniqueitems_validation_request_body**](content_type_json_api/post_uniqueitems_validation_request_body.md) | -[**post_uniqueitems_validation_response_body_for_content_types**](content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md) | -[**post_uri_format_request_body**](content_type_json_api/post_uri_format_request_body.md) | -[**post_uri_format_response_body_for_content_types**](content_type_json_api/post_uri_format_response_body_for_content_types.md) | -[**post_uri_reference_format_request_body**](content_type_json_api/post_uri_reference_format_request_body.md) | -[**post_uri_reference_format_response_body_for_content_types**](content_type_json_api/post_uri_reference_format_response_body_for_content_types.md) | -[**post_uri_template_format_request_body**](content_type_json_api/post_uri_template_format_request_body.md) | -[**post_uri_template_format_response_body_for_content_types**](content_type_json_api/post_uri_template_format_response_body_for_content_types.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](../../paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) | +[**post_additionalproperties_are_allowed_by_default_request_body**](../../paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) | +[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) | +[**post_additionalproperties_can_exist_by_itself_request_body**](../../paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) | +[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_request_body**](../../paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) | +[**post_allof_combined_with_anyof_oneof_request_body**](../../paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) | +[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](../../paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) | +[**post_allof_request_body**](../../paths/request_body_post_allof_request_body/post.md) | +[**post_allof_response_body_for_content_types**](../../paths/response_body_post_allof_response_body_for_content_types/post.md) | +[**post_allof_simple_types_request_body**](../../paths/request_body_post_allof_simple_types_request_body/post.md) | +[**post_allof_simple_types_response_body_for_content_types**](../../paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) | +[**post_allof_with_base_schema_request_body**](../../paths/request_body_post_allof_with_base_schema_request_body/post.md) | +[**post_allof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) | +[**post_allof_with_one_empty_schema_request_body**](../../paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) | +[**post_allof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_first_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) | +[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_last_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) | +[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_two_empty_schemas_request_body**](../../paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) | +[**post_allof_with_two_empty_schemas_response_body_for_content_types**](../../paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) | +[**post_anyof_complex_types_request_body**](../../paths/request_body_post_anyof_complex_types_request_body/post.md) | +[**post_anyof_complex_types_response_body_for_content_types**](../../paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) | +[**post_anyof_request_body**](../../paths/request_body_post_anyof_request_body/post.md) | +[**post_anyof_response_body_for_content_types**](../../paths/response_body_post_anyof_response_body_for_content_types/post.md) | +[**post_anyof_with_base_schema_request_body**](../../paths/request_body_post_anyof_with_base_schema_request_body/post.md) | +[**post_anyof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) | +[**post_anyof_with_one_empty_schema_request_body**](../../paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) | +[**post_anyof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_array_type_matches_arrays_request_body**](../../paths/request_body_post_array_type_matches_arrays_request_body/post.md) | +[**post_array_type_matches_arrays_response_body_for_content_types**](../../paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) | +[**post_boolean_type_matches_booleans_request_body**](../../paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) | +[**post_boolean_type_matches_booleans_response_body_for_content_types**](../../paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) | +[**post_by_int_request_body**](../../paths/request_body_post_by_int_request_body/post.md) | +[**post_by_int_response_body_for_content_types**](../../paths/response_body_post_by_int_response_body_for_content_types/post.md) | +[**post_by_number_request_body**](../../paths/request_body_post_by_number_request_body/post.md) | +[**post_by_number_response_body_for_content_types**](../../paths/response_body_post_by_number_response_body_for_content_types/post.md) | +[**post_by_small_number_request_body**](../../paths/request_body_post_by_small_number_request_body/post.md) | +[**post_by_small_number_response_body_for_content_types**](../../paths/response_body_post_by_small_number_response_body_for_content_types/post.md) | +[**post_date_time_format_request_body**](../../paths/request_body_post_date_time_format_request_body/post.md) | +[**post_date_time_format_response_body_for_content_types**](../../paths/response_body_post_date_time_format_response_body_for_content_types/post.md) | +[**post_email_format_request_body**](../../paths/request_body_post_email_format_request_body/post.md) | +[**post_email_format_response_body_for_content_types**](../../paths/response_body_post_email_format_response_body_for_content_types/post.md) | +[**post_enum_with0_does_not_match_false_request_body**](../../paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) | +[**post_enum_with0_does_not_match_false_response_body_for_content_types**](../../paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) | +[**post_enum_with1_does_not_match_true_request_body**](../../paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) | +[**post_enum_with1_does_not_match_true_response_body_for_content_types**](../../paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) | +[**post_enum_with_escaped_characters_request_body**](../../paths/request_body_post_enum_with_escaped_characters_request_body/post.md) | +[**post_enum_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_enum_with_false_does_not_match0_request_body**](../../paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) | +[**post_enum_with_false_does_not_match0_response_body_for_content_types**](../../paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) | +[**post_enum_with_true_does_not_match1_request_body**](../../paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) | +[**post_enum_with_true_does_not_match1_response_body_for_content_types**](../../paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) | +[**post_enums_in_properties_request_body**](../../paths/request_body_post_enums_in_properties_request_body/post.md) | +[**post_enums_in_properties_response_body_for_content_types**](../../paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) | +[**post_forbidden_property_request_body**](../../paths/request_body_post_forbidden_property_request_body/post.md) | +[**post_forbidden_property_response_body_for_content_types**](../../paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) | +[**post_hostname_format_request_body**](../../paths/request_body_post_hostname_format_request_body/post.md) | +[**post_hostname_format_response_body_for_content_types**](../../paths/response_body_post_hostname_format_response_body_for_content_types/post.md) | +[**post_integer_type_matches_integers_request_body**](../../paths/request_body_post_integer_type_matches_integers_request_body/post.md) | +[**post_integer_type_matches_integers_response_body_for_content_types**](../../paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](../../paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](../../paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) | +[**post_invalid_string_value_for_default_request_body**](../../paths/request_body_post_invalid_string_value_for_default_request_body/post.md) | +[**post_invalid_string_value_for_default_response_body_for_content_types**](../../paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) | +[**post_ipv4_format_request_body**](../../paths/request_body_post_ipv4_format_request_body/post.md) | +[**post_ipv4_format_response_body_for_content_types**](../../paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) | +[**post_ipv6_format_request_body**](../../paths/request_body_post_ipv6_format_request_body/post.md) | +[**post_ipv6_format_response_body_for_content_types**](../../paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) | +[**post_json_pointer_format_request_body**](../../paths/request_body_post_json_pointer_format_request_body/post.md) | +[**post_json_pointer_format_response_body_for_content_types**](../../paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) | +[**post_maximum_validation_request_body**](../../paths/request_body_post_maximum_validation_request_body/post.md) | +[**post_maximum_validation_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) | +[**post_maximum_validation_with_unsigned_integer_request_body**](../../paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) | +[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) | +[**post_maxitems_validation_request_body**](../../paths/request_body_post_maxitems_validation_request_body/post.md) | +[**post_maxitems_validation_response_body_for_content_types**](../../paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) | +[**post_maxlength_validation_request_body**](../../paths/request_body_post_maxlength_validation_request_body/post.md) | +[**post_maxlength_validation_response_body_for_content_types**](../../paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) | +[**post_maxproperties0_means_the_object_is_empty_request_body**](../../paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) | +[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](../../paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) | +[**post_maxproperties_validation_request_body**](../../paths/request_body_post_maxproperties_validation_request_body/post.md) | +[**post_maxproperties_validation_response_body_for_content_types**](../../paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_request_body**](../../paths/request_body_post_minimum_validation_request_body/post.md) | +[**post_minimum_validation_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_with_signed_integer_request_body**](../../paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) | +[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) | +[**post_minitems_validation_request_body**](../../paths/request_body_post_minitems_validation_request_body/post.md) | +[**post_minitems_validation_response_body_for_content_types**](../../paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) | +[**post_minlength_validation_request_body**](../../paths/request_body_post_minlength_validation_request_body/post.md) | +[**post_minlength_validation_response_body_for_content_types**](../../paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) | +[**post_minproperties_validation_request_body**](../../paths/request_body_post_minproperties_validation_request_body/post.md) | +[**post_minproperties_validation_response_body_for_content_types**](../../paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) | +[**post_nested_allof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_anyof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_items_request_body**](../../paths/request_body_post_nested_items_request_body/post.md) | +[**post_nested_items_response_body_for_content_types**](../../paths/response_body_post_nested_items_response_body_for_content_types/post.md) | +[**post_nested_oneof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_not_more_complex_schema_request_body**](../../paths/request_body_post_not_more_complex_schema_request_body/post.md) | +[**post_not_more_complex_schema_response_body_for_content_types**](../../paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) | +[**post_not_request_body**](../../paths/request_body_post_not_request_body/post.md) | +[**post_not_response_body_for_content_types**](../../paths/response_body_post_not_response_body_for_content_types/post.md) | +[**post_nul_characters_in_strings_request_body**](../../paths/request_body_post_nul_characters_in_strings_request_body/post.md) | +[**post_nul_characters_in_strings_response_body_for_content_types**](../../paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) | +[**post_null_type_matches_only_the_null_object_request_body**](../../paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) | +[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](../../paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) | +[**post_number_type_matches_numbers_request_body**](../../paths/request_body_post_number_type_matches_numbers_request_body/post.md) | +[**post_number_type_matches_numbers_response_body_for_content_types**](../../paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) | +[**post_object_properties_validation_request_body**](../../paths/request_body_post_object_properties_validation_request_body/post.md) | +[**post_object_properties_validation_response_body_for_content_types**](../../paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) | +[**post_object_type_matches_objects_request_body**](../../paths/request_body_post_object_type_matches_objects_request_body/post.md) | +[**post_object_type_matches_objects_response_body_for_content_types**](../../paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) | +[**post_oneof_complex_types_request_body**](../../paths/request_body_post_oneof_complex_types_request_body/post.md) | +[**post_oneof_complex_types_response_body_for_content_types**](../../paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) | +[**post_oneof_request_body**](../../paths/request_body_post_oneof_request_body/post.md) | +[**post_oneof_response_body_for_content_types**](../../paths/response_body_post_oneof_response_body_for_content_types/post.md) | +[**post_oneof_with_base_schema_request_body**](../../paths/request_body_post_oneof_with_base_schema_request_body/post.md) | +[**post_oneof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_empty_schema_request_body**](../../paths/request_body_post_oneof_with_empty_schema_request_body/post.md) | +[**post_oneof_with_empty_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_required_request_body**](../../paths/request_body_post_oneof_with_required_request_body/post.md) | +[**post_oneof_with_required_response_body_for_content_types**](../../paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) | +[**post_pattern_is_not_anchored_request_body**](../../paths/request_body_post_pattern_is_not_anchored_request_body/post.md) | +[**post_pattern_is_not_anchored_response_body_for_content_types**](../../paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) | +[**post_pattern_validation_request_body**](../../paths/request_body_post_pattern_validation_request_body/post.md) | +[**post_pattern_validation_response_body_for_content_types**](../../paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) | +[**post_properties_with_escaped_characters_request_body**](../../paths/request_body_post_properties_with_escaped_characters_request_body/post.md) | +[**post_properties_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_property_named_ref_that_is_not_a_reference_request_body**](../../paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) | +[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](../../paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) | +[**post_ref_in_additionalproperties_request_body**](../../paths/request_body_post_ref_in_additionalproperties_request_body/post.md) | +[**post_ref_in_additionalproperties_response_body_for_content_types**](../../paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) | +[**post_ref_in_allof_request_body**](../../paths/request_body_post_ref_in_allof_request_body/post.md) | +[**post_ref_in_allof_response_body_for_content_types**](../../paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) | +[**post_ref_in_anyof_request_body**](../../paths/request_body_post_ref_in_anyof_request_body/post.md) | +[**post_ref_in_anyof_response_body_for_content_types**](../../paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) | +[**post_ref_in_items_request_body**](../../paths/request_body_post_ref_in_items_request_body/post.md) | +[**post_ref_in_items_response_body_for_content_types**](../../paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) | +[**post_ref_in_not_request_body**](../../paths/request_body_post_ref_in_not_request_body/post.md) | +[**post_ref_in_not_response_body_for_content_types**](../../paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) | +[**post_ref_in_oneof_request_body**](../../paths/request_body_post_ref_in_oneof_request_body/post.md) | +[**post_ref_in_oneof_response_body_for_content_types**](../../paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) | +[**post_ref_in_property_request_body**](../../paths/request_body_post_ref_in_property_request_body/post.md) | +[**post_ref_in_property_response_body_for_content_types**](../../paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) | +[**post_required_default_validation_request_body**](../../paths/request_body_post_required_default_validation_request_body/post.md) | +[**post_required_default_validation_response_body_for_content_types**](../../paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) | +[**post_required_validation_request_body**](../../paths/request_body_post_required_validation_request_body/post.md) | +[**post_required_validation_response_body_for_content_types**](../../paths/response_body_post_required_validation_response_body_for_content_types/post.md) | +[**post_required_with_empty_array_request_body**](../../paths/request_body_post_required_with_empty_array_request_body/post.md) | +[**post_required_with_empty_array_response_body_for_content_types**](../../paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) | +[**post_required_with_escaped_characters_request_body**](../../paths/request_body_post_required_with_escaped_characters_request_body/post.md) | +[**post_required_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_simple_enum_validation_request_body**](../../paths/request_body_post_simple_enum_validation_request_body/post.md) | +[**post_simple_enum_validation_response_body_for_content_types**](../../paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) | +[**post_string_type_matches_strings_request_body**](../../paths/request_body_post_string_type_matches_strings_request_body/post.md) | +[**post_string_type_matches_strings_response_body_for_content_types**](../../paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](../../paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](../../paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) | +[**post_uniqueitems_false_validation_request_body**](../../paths/request_body_post_uniqueitems_false_validation_request_body/post.md) | +[**post_uniqueitems_false_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) | +[**post_uniqueitems_validation_request_body**](../../paths/request_body_post_uniqueitems_validation_request_body/post.md) | +[**post_uniqueitems_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) | +[**post_uri_format_request_body**](../../paths/request_body_post_uri_format_request_body/post.md) | +[**post_uri_format_response_body_for_content_types**](../../paths/response_body_post_uri_format_response_body_for_content_types/post.md) | +[**post_uri_reference_format_request_body**](../../paths/request_body_post_uri_reference_format_request_body/post.md) | +[**post_uri_reference_format_response_body_for_content_types**](../../paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) | +[**post_uri_template_format_request_body**](../../paths/request_body_post_uri_template_format_request_body/post.md) | +[**post_uri_template_format_response_body_for_content_types**](../../paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md deleted file mode 100644 index 0ff4ecf29fd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidate( - foo=None, - bar=None, - ) - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_allows_a_schema_which_should_validate_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md deleted file mode 100644 index 544ab4bde76..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md deleted file mode 100644 index d1b935727b4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_are_allowed_by_default.AdditionalpropertiesAreAllowedByDefault(None) - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_are_allowed_by_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md deleted file mode 100644 index 4008524feb6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_are_allowed_by_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md deleted file mode 100644 index d5eacc84f0b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_can_exist_by_itself.AdditionalpropertiesCanExistByItself( - key=True, - ) - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_can_exist_by_itself_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md deleted file mode 100644 index 231bcf6bc0e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_can_exist_by_itself_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md deleted file mode 100644 index 1b68a6d28f4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_should_not_look_in_applicators.AdditionalpropertiesShouldNotLookInApplicators(None) - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_should_not_look_in_applicators_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md deleted file mode 100644 index d3d64b62c20..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md deleted file mode 100644 index 71d2a395d48..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofCombinedWithAnyofOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_combined_with_anyof_oneof.AllofCombinedWithAnyofOneof(None) - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_combined_with_anyof_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md deleted file mode 100644 index e0882dc4b3a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_combined_with_anyof_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_request_body.md deleted file mode 100644 index 10cd59e2e58..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof.Allof(None) - try: - api_response = api_instance.post_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_response_body_for_content_types.md deleted file mode 100644 index b4f5b288f91..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_request_body.md deleted file mode 100644 index e0a584bc19c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_simple_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofSimpleTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_simple_types.AllofSimpleTypes(None) - try: - api_response = api_instance.post_allof_simple_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_simple_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_response_body_for_content_types.md deleted file mode 100644 index d8b555922a1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_simple_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_simple_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofSimpleTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_simple_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_simple_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_request_body.md deleted file mode 100644 index b02215f5ba6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_base_schema.AllofWithBaseSchema({}) - try: - api_response = api_instance.post_allof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 93eb7562836..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_request_body.md deleted file mode 100644 index ecd802bd149..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_one_empty_schema.AllofWithOneEmptySchema(None) - try: - api_response = api_instance.post_allof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 0e405465144..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md deleted file mode 100644 index d78489be20c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheFirstEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_first_empty_schema.AllofWithTheFirstEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_the_first_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 4693c061c8a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_the_first_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md deleted file mode 100644 index 53b0305476b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheLastEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_last_empty_schema.AllofWithTheLastEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_the_last_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md deleted file mode 100644 index ee29a4529c4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_the_last_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_request_body.md deleted file mode 100644 index 56aa977ac9d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_two_empty_schemas_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTwoEmptySchemasRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_two_empty_schemas.AllofWithTwoEmptySchemas(None) - try: - api_response = api_instance.post_allof_with_two_empty_schemas_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_two_empty_schemas_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md deleted file mode 100644 index 6210ad5394d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_two_empty_schemas_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_two_empty_schemas_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_allof_with_two_empty_schemas_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_request_body.md deleted file mode 100644 index e2cc7751932..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_complex_types.AnyofComplexTypes(None) - try: - api_response = api_instance.post_anyof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 1e15557c1fa..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_request_body.md deleted file mode 100644 index f06b6613cd7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof.Anyof(None) - try: - api_response = api_instance.post_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_response_body_for_content_types.md deleted file mode 100644 index ffec6ed9982..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_request_body.md deleted file mode 100644 index f8dc17ab642..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_base_schema.AnyofWithBaseSchema("string_example") - try: - api_response = api_instance.post_anyof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index c4fd64a37d5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_request_body.md deleted file mode 100644 index 4c102d26440..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_one_empty_schema.AnyofWithOneEmptySchema(None) - try: - api_response = api_instance.post_anyof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index cce12bab757..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_anyof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_request_body.md deleted file mode 100644 index d2429f4dac0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_array_type_matches_arrays_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postArrayTypeMatchesArraysRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = array_type_matches_arrays.ArrayTypeMatchesArrays([ - None - ]) - try: - api_response = api_instance.post_array_type_matches_arrays_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_array_type_matches_arrays_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md deleted file mode 100644 index 4974d3fdd2c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_array_type_matches_arrays_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_array_type_matches_arrays_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_array_type_matches_arrays_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_array_type_matches_arrays_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_request_body.md deleted file mode 100644 index 4c74312baee..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_boolean_type_matches_booleans_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBooleanTypeMatchesBooleansRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = boolean_type_matches_booleans.BooleanTypeMatchesBooleans(True) - try: - api_response = api_instance.post_boolean_type_matches_booleans_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_boolean_type_matches_booleans_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md deleted file mode 100644 index ea36cce4cd1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_boolean_type_matches_booleans_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_boolean_type_matches_booleans_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_boolean_type_matches_booleans_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_boolean_type_matches_booleans_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_request_body.md deleted file mode 100644 index 11f608e9e23..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_int_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByIntRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = by_int.ByInt(None) - try: - api_response = api_instance.post_by_int_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_int_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_response_body_for_content_types.md deleted file mode 100644 index 5c725ea2837..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_int_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_int_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByIntResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_int_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_int_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_request_body.md deleted file mode 100644 index 793fc239ae9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = by_number.ByNumber(None) - try: - api_response = api_instance.post_by_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_response_body_for_content_types.md deleted file mode 100644 index 2028618f638..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_request_body.md deleted file mode 100644 index 504b6abe66d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_small_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBySmallNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = by_small_number.BySmallNumber(None) - try: - api_response = api_instance.post_by_small_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_small_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_response_body_for_content_types.md deleted file mode 100644 index 8059b1bd996..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_by_small_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_small_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBySmallNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_small_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_by_small_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_request_body.md deleted file mode 100644 index 7ff90523ebb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_date_time_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postDateTimeFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = date_time_format.DateTimeFormat(None) - try: - api_response = api_instance.post_date_time_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_date_time_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_response_body_for_content_types.md deleted file mode 100644 index 763029c43c1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_date_time_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_date_time_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postDateTimeFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_date_time_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_date_time_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_request_body.md deleted file mode 100644 index 38c12f2f2dc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_email_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEmailFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = email_format.EmailFormat(None) - try: - api_response = api_instance.post_email_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_email_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_response_body_for_content_types.md deleted file mode 100644 index 08e1605d7bc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_email_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_email_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEmailFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_email_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_email_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_request_body.md deleted file mode 100644 index 602c8093dff..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with0_does_not_match_false_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith0DoesNotMatchFalseRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with0_does_not_match_false.EnumWith0DoesNotMatchFalse(0) - try: - api_response = api_instance.post_enum_with0_does_not_match_false_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with0_does_not_match_false_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md deleted file mode 100644 index b3088862009..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with0_does_not_match_false_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with0_does_not_match_false_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with0_does_not_match_false_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_request_body.md deleted file mode 100644 index 607da94e5ea..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with1_does_not_match_true_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith1DoesNotMatchTrueRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with1_does_not_match_true.EnumWith1DoesNotMatchTrue(1) - try: - api_response = api_instance.post_enum_with1_does_not_match_true_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with1_does_not_match_true_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md deleted file mode 100644 index 4e7c4260865..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with1_does_not_match_true_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with1_does_not_match_true_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with1_does_not_match_true_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_request_body.md deleted file mode 100644 index ac29642705f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_escaped_characters.EnumWithEscapedCharacters("foo\nbar") - try: - api_response = api_instance.post_enum_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index bb507d310bb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_request_body.md deleted file mode 100644 index 682be40cea6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_false_does_not_match0_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithFalseDoesNotMatch0RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_false_does_not_match0.EnumWithFalseDoesNotMatch0(False) - try: - api_response = api_instance.post_enum_with_false_does_not_match0_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_false_does_not_match0_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md deleted file mode 100644 index 0a71efd0fa2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_false_does_not_match0_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_false_does_not_match0_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_false_does_not_match0_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_request_body.md deleted file mode 100644 index ed67896ed8a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_true_does_not_match1_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithTrueDoesNotMatch1RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_true_does_not_match1.EnumWithTrueDoesNotMatch1(True) - try: - api_response = api_instance.post_enum_with_true_does_not_match1_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_true_does_not_match1_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md deleted file mode 100644 index feaf5f05bc5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_true_does_not_match1_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_true_does_not_match1_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enum_with_true_does_not_match1_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_request_body.md deleted file mode 100644 index 667b866d3d7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_enums_in_properties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumsInPropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = enums_in_properties.EnumsInProperties( - foo="foo", - bar="bar", - ) - try: - api_response = api_instance.post_enums_in_properties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enums_in_properties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_response_body_for_content_types.md deleted file mode 100644 index 00d9e7d3842..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_enums_in_properties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enums_in_properties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumsInPropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enums_in_properties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_enums_in_properties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_request_body.md deleted file mode 100644 index 3eb34278f9c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_forbidden_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postForbiddenPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = forbidden_property.ForbiddenProperty(None) - try: - api_response = api_instance.post_forbidden_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_forbidden_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_response_body_for_content_types.md deleted file mode 100644 index fc9511e23b1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_forbidden_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_forbidden_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postForbiddenPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_forbidden_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_forbidden_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_request_body.md deleted file mode 100644 index 1e7dcb6ecfc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_hostname_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postHostnameFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = hostname_format.HostnameFormat(None) - try: - api_response = api_instance.post_hostname_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_hostname_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_response_body_for_content_types.md deleted file mode 100644 index 77ccc96605a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_hostname_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_hostname_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postHostnameFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_hostname_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_hostname_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_request_body.md deleted file mode 100644 index 284e338a4cc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_integer_type_matches_integers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIntegerTypeMatchesIntegersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = integer_type_matches_integers.IntegerTypeMatchesIntegers(1) - try: - api_response = api_instance.post_integer_type_matches_integers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_integer_type_matches_integers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md deleted file mode 100644 index 2bbde54fa52..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_integer_type_matches_integers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_integer_type_matches_integers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_integer_type_matches_integers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_integer_type_matches_integers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md deleted file mode 100644 index 97a54e01ae8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_instance_should_not_raise_error_when_float_division_inf.InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf(1) - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md deleted file mode 100644 index bccf01b25ba..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_request_body.md deleted file mode 100644 index 28eb4636ead..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_string_value_for_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidStringValueForDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_string_value_for_default.InvalidStringValueForDefault(None) - try: - api_response = api_instance.post_invalid_string_value_for_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_invalid_string_value_for_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md deleted file mode 100644 index 64d083d1c8d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_invalid_string_value_for_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_string_value_for_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_string_value_for_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_invalid_string_value_for_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_request_body.md deleted file mode 100644 index 512792ca0f9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv4_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv4FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv4_format.Ipv4Format(None) - try: - api_response = api_instance.post_ipv4_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ipv4_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_response_body_for_content_types.md deleted file mode 100644 index 5715b38be75..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv4_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv4_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv4FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv4_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ipv4_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_request_body.md deleted file mode 100644 index 0bf73a1f441..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv6_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv6FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv6_format.Ipv6Format(None) - try: - api_response = api_instance.post_ipv6_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ipv6_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_response_body_for_content_types.md deleted file mode 100644 index 3d5ea54fdb2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ipv6_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv6_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv6FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv6_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ipv6_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_request_body.md deleted file mode 100644 index 28eb8365c29..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_json_pointer_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postJsonPointerFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = json_pointer_format.JsonPointerFormat(None) - try: - api_response = api_instance.post_json_pointer_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_json_pointer_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_response_body_for_content_types.md deleted file mode 100644 index 242c358fbca..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_json_pointer_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_json_pointer_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postJsonPointerFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_json_pointer_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_json_pointer_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_request_body.md deleted file mode 100644 index 5bd8bfa54f5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation.MaximumValidation(None) - try: - api_response = api_instance.post_maximum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maximum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_response_body_for_content_types.md deleted file mode 100644 index ebb14bdc94c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maximum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md deleted file mode 100644 index 2405eb4d4c8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation_with_unsigned_integer.MaximumValidationWithUnsignedInteger(None) - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maximum_validation_with_unsigned_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md deleted file mode 100644 index 6d05b04747b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maximum_validation_with_unsigned_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_request_body.md deleted file mode 100644 index b8cef406928..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maxitems_validation.MaxitemsValidation(None) - try: - api_response = api_instance.post_maxitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_response_body_for_content_types.md deleted file mode 100644 index 114016ff6ed..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_request_body.md deleted file mode 100644 index f5f2a8c59d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maxlength_validation.MaxlengthValidation(None) - try: - api_response = api_instance.post_maxlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_response_body_for_content_types.md deleted file mode 100644 index 406c456c47c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md deleted file mode 100644 index 9852c1d499d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties0_means_the_object_is_empty.Maxproperties0MeansTheObjectIsEmpty(None) - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxproperties0_means_the_object_is_empty_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md deleted file mode 100644 index 47e1d4a47bb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxproperties0_means_the_object_is_empty_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_request_body.md deleted file mode 100644 index ea6243e7306..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties_validation.MaxpropertiesValidation(None) - try: - api_response = api_instance.post_maxproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md deleted file mode 100644 index da3fc3c8037..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_maxproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_maxproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_request_body.md deleted file mode 100644 index f873c80162b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation.MinimumValidation(None) - try: - api_response = api_instance.post_minimum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minimum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_response_body_for_content_types.md deleted file mode 100644 index de153cd7d18..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minimum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md deleted file mode 100644 index 207e2ea7ef1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationWithSignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation_with_signed_integer.MinimumValidationWithSignedInteger(None) - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minimum_validation_with_signed_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md deleted file mode 100644 index 217d5b75300..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minimum_validation_with_signed_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_request_body.md deleted file mode 100644 index 7065a886526..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = minitems_validation.MinitemsValidation(None) - try: - api_response = api_instance.post_minitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_response_body_for_content_types.md deleted file mode 100644 index 8a54add8a5e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_request_body.md deleted file mode 100644 index 75d867954e5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = minlength_validation.MinlengthValidation(None) - try: - api_response = api_instance.post_minlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_response_body_for_content_types.md deleted file mode 100644 index 2b26a726658..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_request_body.md deleted file mode 100644 index 76ab3a0c716..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = minproperties_validation.MinpropertiesValidation(None) - try: - api_response = api_instance.post_minproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 4b59e07170b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_minproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_minproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 4122224246b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_allof_to_check_validation_semantics.NestedAllofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_allof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 12486c1efb0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_allof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 943e68e253a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_anyof_to_check_validation_semantics.NestedAnyofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_anyof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 2c15f1d5b13..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_anyof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_request_body.md deleted file mode 100644 index 633d0be4234..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_request_body.md +++ /dev/null @@ -1,106 +0,0 @@ - -# **post_nested_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_items.NestedItems([ - [ - [ - [ - 3.14 - ] - ] - ] - ]) - try: - api_response = api_instance.post_nested_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_response_body_for_content_types.md deleted file mode 100644 index dc7192816f7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md deleted file mode 100644 index dedd259503d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_oneof_to_check_validation_semantics.NestedOneofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_oneof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 0c8d08b37b0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nested_oneof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_request_body.md deleted file mode 100644 index a77ae82d60e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_more_complex_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotMoreComplexSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = not_more_complex_schema.NotMoreComplexSchema(None) - try: - api_response = api_instance.post_not_more_complex_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_not_more_complex_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md deleted file mode 100644 index ac33d4c45bd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_more_complex_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_more_complex_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_more_complex_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_not_more_complex_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_request_body.md deleted file mode 100644 index 5aa871e1338..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = _not._Not(None) - try: - api_response = api_instance.post_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_response_body_for_content_types.md deleted file mode 100644 index 4cc1479de67..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_request_body.md deleted file mode 100644 index 25e1aca4da5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nul_characters_in_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNulCharactersInStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = nul_characters_in_strings.NulCharactersInStrings("hello\x00there") - try: - api_response = api_instance.post_nul_characters_in_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nul_characters_in_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md deleted file mode 100644 index 6b8e9076b2c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_nul_characters_in_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nul_characters_in_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNulCharactersInStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nul_characters_in_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_nul_characters_in_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md deleted file mode 100644 index f46a530eaec..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), None] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = null_type_matches_only_the_null_object.NullTypeMatchesOnlyTheNullObject(None) - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_null_type_matches_only_the_null_object_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md deleted file mode 100644 index cfebe823a9e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_null_type_matches_only_the_null_object_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_request_body.md deleted file mode 100644 index cefda0a9ddd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_number_type_matches_numbers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNumberTypeMatchesNumbersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = number_type_matches_numbers.NumberTypeMatchesNumbers(3.14) - try: - api_response = api_instance.post_number_type_matches_numbers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_number_type_matches_numbers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md deleted file mode 100644 index 73918c2cdfa..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_number_type_matches_numbers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_number_type_matches_numbers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_number_type_matches_numbers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_number_type_matches_numbers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_request_body.md deleted file mode 100644 index 350213e8534..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_properties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectPropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = object_properties_validation.ObjectPropertiesValidation(None) - try: - api_response = api_instance.post_object_properties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_object_properties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_response_body_for_content_types.md deleted file mode 100644 index 9a81f56a0ab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_properties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_properties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_properties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_object_properties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_request_body.md deleted file mode 100644 index 2cc2209d68a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_type_matches_objects_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectTypeMatchesObjectsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = object_type_matches_objects.ObjectTypeMatchesObjects() - try: - api_response = api_instance.post_object_type_matches_objects_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_object_type_matches_objects_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md deleted file mode 100644 index 121e13beac0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_object_type_matches_objects_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_type_matches_objects_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_type_matches_objects_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_object_type_matches_objects_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_request_body.md deleted file mode 100644 index 0fbaf3d7c9f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_complex_types.OneofComplexTypes(None) - try: - api_response = api_instance.post_oneof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 07f658e5b38..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_request_body.md deleted file mode 100644 index a30f91aaf54..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof.Oneof(None) - try: - api_response = api_instance.post_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_response_body_for_content_types.md deleted file mode 100644 index e1020a4a859..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_request_body.md deleted file mode 100644 index 26c986a0081..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_base_schema.OneofWithBaseSchema("string_example") - try: - api_response = api_instance.post_oneof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index f5e26f7ed31..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_request_body.md deleted file mode 100644 index 4f3841b408d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_empty_schema.OneofWithEmptySchema(None) - try: - api_response = api_instance.post_oneof_with_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 10d74e7a35f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_request_body.md deleted file mode 100644 index 7309d4caebd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_required_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithRequiredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_required.OneofWithRequired() - try: - api_response = api_instance.post_oneof_with_required_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_required_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_response_body_for_content_types.md deleted file mode 100644 index a1c02ad4408..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_oneof_with_required_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_required_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithRequiredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_required_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_oneof_with_required_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_request_body.md deleted file mode 100644 index f453bbdec0b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_is_not_anchored_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternIsNotAnchoredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_is_not_anchored.PatternIsNotAnchored(None) - try: - api_response = api_instance.post_pattern_is_not_anchored_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_pattern_is_not_anchored_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md deleted file mode 100644 index d0e5ea4e54e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_is_not_anchored_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_is_not_anchored_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_is_not_anchored_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_pattern_is_not_anchored_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_request_body.md deleted file mode 100644 index c3e6b24d4c2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_validation.PatternValidation(None) - try: - api_response = api_instance.post_pattern_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_pattern_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_response_body_for_content_types.md deleted file mode 100644 index cee1480878d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_pattern_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_pattern_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_request_body.md deleted file mode 100644 index 28aa8916551..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_properties_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertiesWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = properties_with_escaped_characters.PropertiesWithEscapedCharacters(None) - try: - api_response = api_instance.post_properties_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_properties_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index e8b74b84248..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_properties_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_properties_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_properties_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_properties_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md deleted file mode 100644 index 0c7bca84b29..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_property_named_ref_that_is_not_a_reference_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md deleted file mode 100644 index 985dc233113..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_property_named_ref_that_is_not_a_reference_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_request_body.md deleted file mode 100644 index 63c77a0b8c5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_additionalproperties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAdditionalpropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_additionalproperties.RefInAdditionalproperties( - key=property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None), - ) - try: - api_response = api_instance.post_ref_in_additionalproperties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_additionalproperties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md deleted file mode 100644 index cc47112b2f8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_additionalproperties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_additionalproperties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_additionalproperties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_additionalproperties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_request_body.md deleted file mode 100644 index 54ac3041d7c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_allof.RefInAllof(None) - try: - api_response = api_instance.post_ref_in_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_response_body_for_content_types.md deleted file mode 100644 index 5ef87543b71..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_request_body.md deleted file mode 100644 index fee0c6915c2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_anyof.RefInAnyof(None) - try: - api_response = api_instance.post_ref_in_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md deleted file mode 100644 index 3898f1a4b48..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_request_body.md deleted file mode 100644 index 7d35ddfb865..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_items.RefInItems([ - property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - ]) - try: - api_response = api_instance.post_ref_in_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_response_body_for_content_types.md deleted file mode 100644 index 57b0d61c33c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_request_body.md deleted file mode 100644 index 566d14034b1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_not.RefInNot(None) - try: - api_response = api_instance.post_ref_in_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_response_body_for_content_types.md deleted file mode 100644 index b5a7c896c30..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_request_body.md deleted file mode 100644 index 252244c2af1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_oneof.RefInOneof(None) - try: - api_response = api_instance.post_ref_in_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md deleted file mode 100644 index 5261bc4ee09..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_request_body.md deleted file mode 100644 index 3d496445edd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_property.RefInProperty(None) - try: - api_response = api_instance.post_ref_in_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_response_body_for_content_types.md deleted file mode 100644 index 9f7604dbca4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_ref_in_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_ref_in_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_request_body.md deleted file mode 100644 index f03aa29e2bf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_default_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredDefaultValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = required_default_validation.RequiredDefaultValidation(None) - try: - api_response = api_instance.post_required_default_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_default_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_response_body_for_content_types.md deleted file mode 100644 index 5b154d65e4d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_default_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_default_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_default_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_default_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_request_body.md deleted file mode 100644 index 6a9c3f6d96d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = required_validation.RequiredValidation(None) - try: - api_response = api_instance.post_required_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_response_body_for_content_types.md deleted file mode 100644 index e3fd49a834d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_request_body.md deleted file mode 100644 index 759764c3b7a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_empty_array_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEmptyArrayRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_empty_array.RequiredWithEmptyArray(None) - try: - api_response = api_instance.post_required_with_empty_array_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_with_empty_array_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md deleted file mode 100644 index 56c7a1c6958..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_empty_array_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_empty_array_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_empty_array_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_with_empty_array_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_request_body.md deleted file mode 100644 index 1b44cbac84a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_escaped_characters.RequiredWithEscapedCharacters(None) - try: - api_response = api_instance.post_required_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 35e65d7152a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_required_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_required_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_request_body.md deleted file mode 100644 index cfd7b492ef9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_simple_enum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postSimpleEnumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = simple_enum_validation.SimpleEnumValidation(1) - try: - api_response = api_instance.post_simple_enum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_simple_enum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md deleted file mode 100644 index 65f86ae5ddb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_simple_enum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_simple_enum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postSimpleEnumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_simple_enum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_simple_enum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_request_body.md deleted file mode 100644 index 7e078b9e61c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_string_type_matches_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postStringTypeMatchesStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = string_type_matches_strings.StringTypeMatchesStrings("string_example") - try: - api_response = api_instance.post_string_type_matches_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_string_type_matches_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md deleted file mode 100644 index a8fffa0d42a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_string_type_matches_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_string_type_matches_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_string_type_matches_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_string_type_matches_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md deleted file mode 100644 index e87001a4c14..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = the_default_keyword_does_not_do_anything_if_the_property_is_missing.TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing( - alpha=5, - ) - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md deleted file mode 100644 index 8bdb8ed32b5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_request_body.md deleted file mode 100644 index d59df0c541b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_false_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsFalseValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_false_validation.UniqueitemsFalseValidation(None) - try: - api_response = api_instance.post_uniqueitems_false_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uniqueitems_false_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md deleted file mode 100644 index abe61386d11..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_false_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_false_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_false_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uniqueitems_false_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_request_body.md deleted file mode 100644 index 543025c2fe7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_validation.UniqueitemsValidation(None) - try: - api_response = api_instance.post_uniqueitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uniqueitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md deleted file mode 100644 index 5d8f823f352..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uniqueitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uniqueitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_request_body.md deleted file mode 100644 index 224c5310bf3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_format.UriFormat(None) - try: - api_response = api_instance.post_uri_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_response_body_for_content_types.md deleted file mode 100644 index ba4fdbe3a73..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_request_body.md deleted file mode 100644 index 630a6172f5d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_reference_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriReferenceFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_reference_format.UriReferenceFormat(None) - try: - api_response = api_instance.post_uri_reference_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_reference_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_response_body_for_content_types.md deleted file mode 100644 index 142cec0f947..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_reference_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_reference_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriReferenceFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_reference_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_reference_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_request_body.md deleted file mode 100644 index ce91b334e9a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_template_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriTemplateFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_template_format.UriTemplateFormat(None) - try: - api_response = api_instance.post_uri_template_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_template_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_response_body_for_content_types.md deleted file mode 100644 index d654b697206..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/content_type_json_api/post_uri_template_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_template_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriTemplateFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import content_type_json_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = content_type_json_api.ContentTypeJsonApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_template_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ContentTypeJsonApi->post_uri_template_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../content_type_json_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api.md index 397c7c48948..b207e3320f0 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_invalid_string_value_for_default_request_body**](default_api/post_invalid_string_value_for_default_request_body.md) | -[**post_invalid_string_value_for_default_response_body_for_content_types**](default_api/post_invalid_string_value_for_default_response_body_for_content_types.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) | +[**post_invalid_string_value_for_default_request_body**](../../paths/request_body_post_invalid_string_value_for_default_request_body/post.md) | +[**post_invalid_string_value_for_default_response_body_for_content_types**](../../paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](../../paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](../../paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_request_body.md deleted file mode 100644 index 169e7b8612e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_string_value_for_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidStringValueForDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_string_value_for_default.InvalidStringValueForDefault(None) - try: - api_response = api_instance.post_invalid_string_value_for_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling DefaultApi->post_invalid_string_value_for_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_response_body_for_content_types.md deleted file mode 100644 index 1b4a2113ff4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_invalid_string_value_for_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_string_value_for_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_string_value_for_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling DefaultApi->post_invalid_string_value_for_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md deleted file mode 100644 index 94b5ea0926f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example passing only required values which don't have defaults set - body = the_default_keyword_does_not_do_anything_if_the_property_is_missing.TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing( - alpha=5, - ) - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling DefaultApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md deleted file mode 100644 index d6fec7b2c9a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/default_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling DefaultApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api.md index c3dd37c605a..529224b8e7b 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api.md @@ -9,21 +9,21 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_enum_with0_does_not_match_false_request_body**](enum_api/post_enum_with0_does_not_match_false_request_body.md) | -[**post_enum_with0_does_not_match_false_response_body_for_content_types**](enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) | -[**post_enum_with1_does_not_match_true_request_body**](enum_api/post_enum_with1_does_not_match_true_request_body.md) | -[**post_enum_with1_does_not_match_true_response_body_for_content_types**](enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) | -[**post_enum_with_escaped_characters_request_body**](enum_api/post_enum_with_escaped_characters_request_body.md) | -[**post_enum_with_escaped_characters_response_body_for_content_types**](enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md) | -[**post_enum_with_false_does_not_match0_request_body**](enum_api/post_enum_with_false_does_not_match0_request_body.md) | -[**post_enum_with_false_does_not_match0_response_body_for_content_types**](enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) | -[**post_enum_with_true_does_not_match1_request_body**](enum_api/post_enum_with_true_does_not_match1_request_body.md) | -[**post_enum_with_true_does_not_match1_response_body_for_content_types**](enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) | -[**post_enums_in_properties_request_body**](enum_api/post_enums_in_properties_request_body.md) | -[**post_enums_in_properties_response_body_for_content_types**](enum_api/post_enums_in_properties_response_body_for_content_types.md) | -[**post_nul_characters_in_strings_request_body**](enum_api/post_nul_characters_in_strings_request_body.md) | -[**post_nul_characters_in_strings_response_body_for_content_types**](enum_api/post_nul_characters_in_strings_response_body_for_content_types.md) | -[**post_simple_enum_validation_request_body**](enum_api/post_simple_enum_validation_request_body.md) | -[**post_simple_enum_validation_response_body_for_content_types**](enum_api/post_simple_enum_validation_response_body_for_content_types.md) | +[**post_enum_with0_does_not_match_false_request_body**](../../paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) | +[**post_enum_with0_does_not_match_false_response_body_for_content_types**](../../paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) | +[**post_enum_with1_does_not_match_true_request_body**](../../paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) | +[**post_enum_with1_does_not_match_true_response_body_for_content_types**](../../paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) | +[**post_enum_with_escaped_characters_request_body**](../../paths/request_body_post_enum_with_escaped_characters_request_body/post.md) | +[**post_enum_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_enum_with_false_does_not_match0_request_body**](../../paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) | +[**post_enum_with_false_does_not_match0_response_body_for_content_types**](../../paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) | +[**post_enum_with_true_does_not_match1_request_body**](../../paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) | +[**post_enum_with_true_does_not_match1_response_body_for_content_types**](../../paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) | +[**post_enums_in_properties_request_body**](../../paths/request_body_post_enums_in_properties_request_body/post.md) | +[**post_enums_in_properties_response_body_for_content_types**](../../paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) | +[**post_nul_characters_in_strings_request_body**](../../paths/request_body_post_nul_characters_in_strings_request_body/post.md) | +[**post_nul_characters_in_strings_response_body_for_content_types**](../../paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) | +[**post_simple_enum_validation_request_body**](../../paths/request_body_post_simple_enum_validation_request_body/post.md) | +[**post_simple_enum_validation_response_body_for_content_types**](../../paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_request_body.md deleted file mode 100644 index 462aad9cbc7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with0_does_not_match_false_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith0DoesNotMatchFalseRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with0_does_not_match_false.EnumWith0DoesNotMatchFalse(0) - try: - api_response = api_instance.post_enum_with0_does_not_match_false_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with0_does_not_match_false_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md deleted file mode 100644 index 4ad9de25d96..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with0_does_not_match_false_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with0_does_not_match_false_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with0_does_not_match_false_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_request_body.md deleted file mode 100644 index c98c3af8cf5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with1_does_not_match_true_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith1DoesNotMatchTrueRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with1_does_not_match_true.EnumWith1DoesNotMatchTrue(1) - try: - api_response = api_instance.post_enum_with1_does_not_match_true_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with1_does_not_match_true_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md deleted file mode 100644 index 3f92b9b2a62..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with1_does_not_match_true_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with1_does_not_match_true_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with1_does_not_match_true_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_request_body.md deleted file mode 100644 index 92534508176..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_escaped_characters.EnumWithEscapedCharacters("foo\nbar") - try: - api_response = api_instance.post_enum_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 56e7082d3e3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_request_body.md deleted file mode 100644 index 3b0eb2fd303..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_false_does_not_match0_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithFalseDoesNotMatch0RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_false_does_not_match0.EnumWithFalseDoesNotMatch0(False) - try: - api_response = api_instance.post_enum_with_false_does_not_match0_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_false_does_not_match0_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md deleted file mode 100644 index 9cdc23aa63b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_false_does_not_match0_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_false_does_not_match0_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_false_does_not_match0_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_request_body.md deleted file mode 100644 index 8f464dc8ee6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_true_does_not_match1_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithTrueDoesNotMatch1RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_true_does_not_match1.EnumWithTrueDoesNotMatch1(True) - try: - api_response = api_instance.post_enum_with_true_does_not_match1_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_true_does_not_match1_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md deleted file mode 100644 index 07f5cd8181f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_true_does_not_match1_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_true_does_not_match1_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enum_with_true_does_not_match1_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_request_body.md deleted file mode 100644 index c51b0ff035c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_enums_in_properties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumsInPropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = enums_in_properties.EnumsInProperties( - foo="foo", - bar="bar", - ) - try: - api_response = api_instance.post_enums_in_properties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enums_in_properties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_response_body_for_content_types.md deleted file mode 100644 index fa8d0388bdd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_enums_in_properties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enums_in_properties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumsInPropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enums_in_properties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_enums_in_properties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_request_body.md deleted file mode 100644 index 10c0c1edbff..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nul_characters_in_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNulCharactersInStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = nul_characters_in_strings.NulCharactersInStrings("hello\x00there") - try: - api_response = api_instance.post_nul_characters_in_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_nul_characters_in_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_response_body_for_content_types.md deleted file mode 100644 index 3e5e6db7fae..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_nul_characters_in_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nul_characters_in_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNulCharactersInStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nul_characters_in_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_nul_characters_in_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_request_body.md deleted file mode 100644 index 24fd253cb97..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_simple_enum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postSimpleEnumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example passing only required values which don't have defaults set - body = simple_enum_validation.SimpleEnumValidation(1) - try: - api_response = api_instance.post_simple_enum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_simple_enum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_response_body_for_content_types.md deleted file mode 100644 index 30124ec5471..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/enum_api/post_simple_enum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_simple_enum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postSimpleEnumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import enum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = enum_api.EnumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_simple_enum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling EnumApi->post_simple_enum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../enum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api.md index 11602ae0834..5f25edf69da 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api.md @@ -9,23 +9,23 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_date_time_format_request_body**](format_api/post_date_time_format_request_body.md) | -[**post_date_time_format_response_body_for_content_types**](format_api/post_date_time_format_response_body_for_content_types.md) | -[**post_email_format_request_body**](format_api/post_email_format_request_body.md) | -[**post_email_format_response_body_for_content_types**](format_api/post_email_format_response_body_for_content_types.md) | -[**post_hostname_format_request_body**](format_api/post_hostname_format_request_body.md) | -[**post_hostname_format_response_body_for_content_types**](format_api/post_hostname_format_response_body_for_content_types.md) | -[**post_ipv4_format_request_body**](format_api/post_ipv4_format_request_body.md) | -[**post_ipv4_format_response_body_for_content_types**](format_api/post_ipv4_format_response_body_for_content_types.md) | -[**post_ipv6_format_request_body**](format_api/post_ipv6_format_request_body.md) | -[**post_ipv6_format_response_body_for_content_types**](format_api/post_ipv6_format_response_body_for_content_types.md) | -[**post_json_pointer_format_request_body**](format_api/post_json_pointer_format_request_body.md) | -[**post_json_pointer_format_response_body_for_content_types**](format_api/post_json_pointer_format_response_body_for_content_types.md) | -[**post_uri_format_request_body**](format_api/post_uri_format_request_body.md) | -[**post_uri_format_response_body_for_content_types**](format_api/post_uri_format_response_body_for_content_types.md) | -[**post_uri_reference_format_request_body**](format_api/post_uri_reference_format_request_body.md) | -[**post_uri_reference_format_response_body_for_content_types**](format_api/post_uri_reference_format_response_body_for_content_types.md) | -[**post_uri_template_format_request_body**](format_api/post_uri_template_format_request_body.md) | -[**post_uri_template_format_response_body_for_content_types**](format_api/post_uri_template_format_response_body_for_content_types.md) | +[**post_date_time_format_request_body**](../../paths/request_body_post_date_time_format_request_body/post.md) | +[**post_date_time_format_response_body_for_content_types**](../../paths/response_body_post_date_time_format_response_body_for_content_types/post.md) | +[**post_email_format_request_body**](../../paths/request_body_post_email_format_request_body/post.md) | +[**post_email_format_response_body_for_content_types**](../../paths/response_body_post_email_format_response_body_for_content_types/post.md) | +[**post_hostname_format_request_body**](../../paths/request_body_post_hostname_format_request_body/post.md) | +[**post_hostname_format_response_body_for_content_types**](../../paths/response_body_post_hostname_format_response_body_for_content_types/post.md) | +[**post_ipv4_format_request_body**](../../paths/request_body_post_ipv4_format_request_body/post.md) | +[**post_ipv4_format_response_body_for_content_types**](../../paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) | +[**post_ipv6_format_request_body**](../../paths/request_body_post_ipv6_format_request_body/post.md) | +[**post_ipv6_format_response_body_for_content_types**](../../paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) | +[**post_json_pointer_format_request_body**](../../paths/request_body_post_json_pointer_format_request_body/post.md) | +[**post_json_pointer_format_response_body_for_content_types**](../../paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) | +[**post_uri_format_request_body**](../../paths/request_body_post_uri_format_request_body/post.md) | +[**post_uri_format_response_body_for_content_types**](../../paths/response_body_post_uri_format_response_body_for_content_types/post.md) | +[**post_uri_reference_format_request_body**](../../paths/request_body_post_uri_reference_format_request_body/post.md) | +[**post_uri_reference_format_response_body_for_content_types**](../../paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) | +[**post_uri_template_format_request_body**](../../paths/request_body_post_uri_template_format_request_body/post.md) | +[**post_uri_template_format_response_body_for_content_types**](../../paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_request_body.md deleted file mode 100644 index 228bdb622fb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_date_time_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postDateTimeFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = date_time_format.DateTimeFormat(None) - try: - api_response = api_instance.post_date_time_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_date_time_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_response_body_for_content_types.md deleted file mode 100644 index 1739aec8aad..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_date_time_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_date_time_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postDateTimeFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_date_time_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_date_time_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_request_body.md deleted file mode 100644 index 53a111fe775..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_email_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEmailFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = email_format.EmailFormat(None) - try: - api_response = api_instance.post_email_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_email_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_response_body_for_content_types.md deleted file mode 100644 index ce6bc3fd79b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_email_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_email_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEmailFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_email_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_email_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_request_body.md deleted file mode 100644 index 84298614225..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_hostname_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postHostnameFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = hostname_format.HostnameFormat(None) - try: - api_response = api_instance.post_hostname_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_hostname_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_response_body_for_content_types.md deleted file mode 100644 index 888c1635fad..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_hostname_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_hostname_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postHostnameFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_hostname_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_hostname_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_request_body.md deleted file mode 100644 index 0bfbff05363..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv4_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv4FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv4_format.Ipv4Format(None) - try: - api_response = api_instance.post_ipv4_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_ipv4_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_response_body_for_content_types.md deleted file mode 100644 index 05fdddab1bf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv4_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv4_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv4FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv4_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_ipv4_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_request_body.md deleted file mode 100644 index 261ced82ae0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv6_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv6FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv6_format.Ipv6Format(None) - try: - api_response = api_instance.post_ipv6_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_ipv6_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_response_body_for_content_types.md deleted file mode 100644 index 72a92a4ea94..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_ipv6_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv6_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv6FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv6_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_ipv6_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_request_body.md deleted file mode 100644 index cadaec0951a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_json_pointer_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postJsonPointerFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = json_pointer_format.JsonPointerFormat(None) - try: - api_response = api_instance.post_json_pointer_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_json_pointer_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_response_body_for_content_types.md deleted file mode 100644 index 8ea72cb06d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_json_pointer_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_json_pointer_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postJsonPointerFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_json_pointer_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_json_pointer_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_request_body.md deleted file mode 100644 index 15f1dac3609..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_format.UriFormat(None) - try: - api_response = api_instance.post_uri_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_response_body_for_content_types.md deleted file mode 100644 index 2e9340cf4a8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_request_body.md deleted file mode 100644 index 29e31379c06..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_reference_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriReferenceFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_reference_format.UriReferenceFormat(None) - try: - api_response = api_instance.post_uri_reference_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_reference_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_response_body_for_content_types.md deleted file mode 100644 index 29a75d98dde..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_reference_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_reference_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriReferenceFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_reference_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_reference_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_request_body.md deleted file mode 100644 index f01e709cdc6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_template_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriTemplateFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_template_format.UriTemplateFormat(None) - try: - api_response = api_instance.post_uri_template_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_template_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_response_body_for_content_types.md deleted file mode 100644 index 556946c5f2e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/format_api/post_uri_template_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_template_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriTemplateFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import format_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = format_api.FormatApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_template_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling FormatApi->post_uri_template_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../format_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api.md index db9c1e80d76..7d4b0563bbb 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_nested_items_request_body**](items_api/post_nested_items_request_body.md) | -[**post_nested_items_response_body_for_content_types**](items_api/post_nested_items_response_body_for_content_types.md) | +[**post_nested_items_request_body**](../../paths/request_body_post_nested_items_request_body/post.md) | +[**post_nested_items_response_body_for_content_types**](../../paths/response_body_post_nested_items_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_request_body.md deleted file mode 100644 index 7fe4546388e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_request_body.md +++ /dev/null @@ -1,106 +0,0 @@ - -# **post_nested_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = items_api.ItemsApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_items.NestedItems([ - [ - [ - [ - 3.14 - ] - ] - ] - ]) - try: - api_response = api_instance.post_nested_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ItemsApi->post_nested_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_response_body_for_content_types.md deleted file mode 100644 index 4acd0868937..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/items_api/post_nested_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = items_api.ItemsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ItemsApi->post_nested_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api.md index 64944a20c06..3c2f39b81d9 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_maxitems_validation_request_body**](max_items_api/post_maxitems_validation_request_body.md) | -[**post_maxitems_validation_response_body_for_content_types**](max_items_api/post_maxitems_validation_response_body_for_content_types.md) | +[**post_maxitems_validation_request_body**](../../paths/request_body_post_maxitems_validation_request_body/post.md) | +[**post_maxitems_validation_response_body_for_content_types**](../../paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_request_body.md deleted file mode 100644 index a8885dee31c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_items_api.MaxItemsApi(api_client) - - # example passing only required values which don't have defaults set - body = maxitems_validation.MaxitemsValidation(None) - try: - api_response = api_instance.post_maxitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxItemsApi->post_maxitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_response_body_for_content_types.md deleted file mode 100644 index 28ba9ecdc17..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_items_api/post_maxitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_items_api.MaxItemsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxItemsApi->post_maxitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api.md index 0b218f91810..581d53251b9 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_maxlength_validation_request_body**](max_length_api/post_maxlength_validation_request_body.md) | -[**post_maxlength_validation_response_body_for_content_types**](max_length_api/post_maxlength_validation_response_body_for_content_types.md) | +[**post_maxlength_validation_request_body**](../../paths/request_body_post_maxlength_validation_request_body/post.md) | +[**post_maxlength_validation_response_body_for_content_types**](../../paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_request_body.md deleted file mode 100644 index a1d0205bd8c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_length_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_length_api.MaxLengthApi(api_client) - - # example passing only required values which don't have defaults set - body = maxlength_validation.MaxlengthValidation(None) - try: - api_response = api_instance.post_maxlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxLengthApi->post_maxlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_length_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_response_body_for_content_types.md deleted file mode 100644 index c0a0045851f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_length_api/post_maxlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_length_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_length_api.MaxLengthApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxLengthApi->post_maxlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_length_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api.md index 03c05c5f12d..6274432bfaf 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_maxproperties0_means_the_object_is_empty_request_body**](max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md) | -[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) | -[**post_maxproperties_validation_request_body**](max_properties_api/post_maxproperties_validation_request_body.md) | -[**post_maxproperties_validation_response_body_for_content_types**](max_properties_api/post_maxproperties_validation_response_body_for_content_types.md) | +[**post_maxproperties0_means_the_object_is_empty_request_body**](../../paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) | +[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](../../paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) | +[**post_maxproperties_validation_request_body**](../../paths/request_body_post_maxproperties_validation_request_body/post.md) | +[**post_maxproperties_validation_response_body_for_content_types**](../../paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md deleted file mode 100644 index 9b903ec2a24..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_properties_api.MaxPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties0_means_the_object_is_empty.Maxproperties0MeansTheObjectIsEmpty(None) - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxPropertiesApi->post_maxproperties0_means_the_object_is_empty_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md deleted file mode 100644 index ebc46c88288..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_properties_api.MaxPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxPropertiesApi->post_maxproperties0_means_the_object_is_empty_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_request_body.md deleted file mode 100644 index cff1b4b3e49..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_properties_api.MaxPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties_validation.MaxpropertiesValidation(None) - try: - api_response = api_instance.post_maxproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxPropertiesApi->post_maxproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 64dd729318e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/max_properties_api/post_maxproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import max_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = max_properties_api.MaxPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaxPropertiesApi->post_maxproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../max_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api.md index c4733e596ff..431e5c64ad4 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_maximum_validation_request_body**](maximum_api/post_maximum_validation_request_body.md) | -[**post_maximum_validation_response_body_for_content_types**](maximum_api/post_maximum_validation_response_body_for_content_types.md) | -[**post_maximum_validation_with_unsigned_integer_request_body**](maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md) | -[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) | +[**post_maximum_validation_request_body**](../../paths/request_body_post_maximum_validation_request_body/post.md) | +[**post_maximum_validation_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) | +[**post_maximum_validation_with_unsigned_integer_request_body**](../../paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) | +[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_request_body.md deleted file mode 100644 index ce8db71408b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import maximum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = maximum_api.MaximumApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation.MaximumValidation(None) - try: - api_response = api_instance.post_maximum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaximumApi->post_maximum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../maximum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_response_body_for_content_types.md deleted file mode 100644 index f4ea9a0398b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import maximum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = maximum_api.MaximumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaximumApi->post_maximum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../maximum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md deleted file mode 100644 index 0060bdfd690..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import maximum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = maximum_api.MaximumApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation_with_unsigned_integer.MaximumValidationWithUnsignedInteger(None) - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaximumApi->post_maximum_validation_with_unsigned_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../maximum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md deleted file mode 100644 index 7bccb8e714d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/maximum_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import maximum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = maximum_api.MaximumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MaximumApi->post_maximum_validation_with_unsigned_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../maximum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api.md index 074e9bfe57e..eac5307be28 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_minitems_validation_request_body**](min_items_api/post_minitems_validation_request_body.md) | -[**post_minitems_validation_response_body_for_content_types**](min_items_api/post_minitems_validation_response_body_for_content_types.md) | +[**post_minitems_validation_request_body**](../../paths/request_body_post_minitems_validation_request_body/post.md) | +[**post_minitems_validation_response_body_for_content_types**](../../paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_request_body.md deleted file mode 100644 index a94c7b25c51..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_items_api.MinItemsApi(api_client) - - # example passing only required values which don't have defaults set - body = minitems_validation.MinitemsValidation(None) - try: - api_response = api_instance.post_minitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinItemsApi->post_minitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_response_body_for_content_types.md deleted file mode 100644 index 1ae8a6c252a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_items_api/post_minitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_items_api.MinItemsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinItemsApi->post_minitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api.md index c3e71d0fa24..76d6f3acdbe 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_minlength_validation_request_body**](min_length_api/post_minlength_validation_request_body.md) | -[**post_minlength_validation_response_body_for_content_types**](min_length_api/post_minlength_validation_response_body_for_content_types.md) | +[**post_minlength_validation_request_body**](../../paths/request_body_post_minlength_validation_request_body/post.md) | +[**post_minlength_validation_response_body_for_content_types**](../../paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_request_body.md deleted file mode 100644 index e5b8512cf07..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_length_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_length_api.MinLengthApi(api_client) - - # example passing only required values which don't have defaults set - body = minlength_validation.MinlengthValidation(None) - try: - api_response = api_instance.post_minlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinLengthApi->post_minlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_length_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_response_body_for_content_types.md deleted file mode 100644 index 2109b21cb67..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_length_api/post_minlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_length_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_length_api.MinLengthApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinLengthApi->post_minlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_length_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api.md index 0f9b1dd4c4a..fc7595be9e2 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api.md @@ -9,7 +9,7 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_minproperties_validation_request_body**](min_properties_api/post_minproperties_validation_request_body.md) | -[**post_minproperties_validation_response_body_for_content_types**](min_properties_api/post_minproperties_validation_response_body_for_content_types.md) | +[**post_minproperties_validation_request_body**](../../paths/request_body_post_minproperties_validation_request_body/post.md) | +[**post_minproperties_validation_response_body_for_content_types**](../../paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_request_body.md deleted file mode 100644 index be0859ec97b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_properties_api.MinPropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = minproperties_validation.MinpropertiesValidation(None) - try: - api_response = api_instance.post_minproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinPropertiesApi->post_minproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 99fa226c357..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/min_properties_api/post_minproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import min_properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = min_properties_api.MinPropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinPropertiesApi->post_minproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../min_properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api.md index bbb0622b56a..62d9b842e22 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_minimum_validation_request_body**](minimum_api/post_minimum_validation_request_body.md) | -[**post_minimum_validation_response_body_for_content_types**](minimum_api/post_minimum_validation_response_body_for_content_types.md) | -[**post_minimum_validation_with_signed_integer_request_body**](minimum_api/post_minimum_validation_with_signed_integer_request_body.md) | -[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) | +[**post_minimum_validation_request_body**](../../paths/request_body_post_minimum_validation_request_body/post.md) | +[**post_minimum_validation_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_with_signed_integer_request_body**](../../paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) | +[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_request_body.md deleted file mode 100644 index 66fad9ee91c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import minimum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = minimum_api.MinimumApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation.MinimumValidation(None) - try: - api_response = api_instance.post_minimum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinimumApi->post_minimum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../minimum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_response_body_for_content_types.md deleted file mode 100644 index e03b3abb48f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import minimum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = minimum_api.MinimumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinimumApi->post_minimum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../minimum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_request_body.md deleted file mode 100644 index 872e948c69c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationWithSignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import minimum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = minimum_api.MinimumApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation_with_signed_integer.MinimumValidationWithSignedInteger(None) - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinimumApi->post_minimum_validation_with_signed_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../minimum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md deleted file mode 100644 index 14da7c05152..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/minimum_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import minimum_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = minimum_api.MinimumApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MinimumApi->post_minimum_validation_with_signed_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../minimum_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api.md index 29a27d7dcfe..91592db4255 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api.md @@ -9,13 +9,13 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_by_int_request_body**](multiple_of_api/post_by_int_request_body.md) | -[**post_by_int_response_body_for_content_types**](multiple_of_api/post_by_int_response_body_for_content_types.md) | -[**post_by_number_request_body**](multiple_of_api/post_by_number_request_body.md) | -[**post_by_number_response_body_for_content_types**](multiple_of_api/post_by_number_response_body_for_content_types.md) | -[**post_by_small_number_request_body**](multiple_of_api/post_by_small_number_request_body.md) | -[**post_by_small_number_response_body_for_content_types**](multiple_of_api/post_by_small_number_response_body_for_content_types.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) | +[**post_by_int_request_body**](../../paths/request_body_post_by_int_request_body/post.md) | +[**post_by_int_response_body_for_content_types**](../../paths/response_body_post_by_int_response_body_for_content_types/post.md) | +[**post_by_number_request_body**](../../paths/request_body_post_by_number_request_body/post.md) | +[**post_by_number_response_body_for_content_types**](../../paths/response_body_post_by_number_response_body_for_content_types/post.md) | +[**post_by_small_number_request_body**](../../paths/request_body_post_by_small_number_request_body/post.md) | +[**post_by_small_number_response_body_for_content_types**](../../paths/response_body_post_by_small_number_response_body_for_content_types/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](../../paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](../../paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_request_body.md deleted file mode 100644 index 125ed9922fe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_int_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByIntRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example passing only required values which don't have defaults set - body = by_int.ByInt(None) - try: - api_response = api_instance.post_by_int_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_int_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_response_body_for_content_types.md deleted file mode 100644 index 687cbe24206..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_int_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_int_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByIntResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_int_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_int_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_request_body.md deleted file mode 100644 index ae01e9d834d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example passing only required values which don't have defaults set - body = by_number.ByNumber(None) - try: - api_response = api_instance.post_by_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_response_body_for_content_types.md deleted file mode 100644 index b794b3f1d56..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_request_body.md deleted file mode 100644 index 64aab91eef4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_small_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBySmallNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example passing only required values which don't have defaults set - body = by_small_number.BySmallNumber(None) - try: - api_response = api_instance.post_by_small_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_small_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_response_body_for_content_types.md deleted file mode 100644 index c801849d36e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_by_small_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_small_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBySmallNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_small_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_by_small_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md deleted file mode 100644 index f69628499cc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_instance_should_not_raise_error_when_float_division_inf.InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf(1) - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md deleted file mode 100644 index 6fc1571a943..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/multiple_of_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import multiple_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = multiple_of_api.MultipleOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling MultipleOfApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../multiple_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api.md index fb365303c58..42058af96dd 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api.md @@ -9,17 +9,17 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_nested_oneof_to_check_validation_semantics_request_body**](one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md) | -[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_oneof_complex_types_request_body**](one_of_api/post_oneof_complex_types_request_body.md) | -[**post_oneof_complex_types_response_body_for_content_types**](one_of_api/post_oneof_complex_types_response_body_for_content_types.md) | -[**post_oneof_request_body**](one_of_api/post_oneof_request_body.md) | -[**post_oneof_response_body_for_content_types**](one_of_api/post_oneof_response_body_for_content_types.md) | -[**post_oneof_with_base_schema_request_body**](one_of_api/post_oneof_with_base_schema_request_body.md) | -[**post_oneof_with_base_schema_response_body_for_content_types**](one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md) | -[**post_oneof_with_empty_schema_request_body**](one_of_api/post_oneof_with_empty_schema_request_body.md) | -[**post_oneof_with_empty_schema_response_body_for_content_types**](one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md) | -[**post_oneof_with_required_request_body**](one_of_api/post_oneof_with_required_request_body.md) | -[**post_oneof_with_required_response_body_for_content_types**](one_of_api/post_oneof_with_required_response_body_for_content_types.md) | +[**post_nested_oneof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_oneof_complex_types_request_body**](../../paths/request_body_post_oneof_complex_types_request_body/post.md) | +[**post_oneof_complex_types_response_body_for_content_types**](../../paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) | +[**post_oneof_request_body**](../../paths/request_body_post_oneof_request_body/post.md) | +[**post_oneof_response_body_for_content_types**](../../paths/response_body_post_oneof_response_body_for_content_types/post.md) | +[**post_oneof_with_base_schema_request_body**](../../paths/request_body_post_oneof_with_base_schema_request_body/post.md) | +[**post_oneof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_empty_schema_request_body**](../../paths/request_body_post_oneof_with_empty_schema_request_body/post.md) | +[**post_oneof_with_empty_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_required_request_body**](../../paths/request_body_post_oneof_with_required_request_body/post.md) | +[**post_oneof_with_required_response_body_for_content_types**](../../paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md deleted file mode 100644 index e6074791b32..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_oneof_to_check_validation_semantics.NestedOneofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_nested_oneof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 1c8581a8629..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_nested_oneof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_request_body.md deleted file mode 100644 index 2ad277c1f95..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_complex_types.OneofComplexTypes(None) - try: - api_response = api_instance.post_oneof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_response_body_for_content_types.md deleted file mode 100644 index f892ff9713e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_request_body.md deleted file mode 100644 index 73523f0a83b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof.Oneof(None) - try: - api_response = api_instance.post_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_response_body_for_content_types.md deleted file mode 100644 index 962a90b6a32..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_request_body.md deleted file mode 100644 index 65120e6108c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_base_schema.OneofWithBaseSchema("string_example") - try: - api_response = api_instance.post_oneof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 4dc8d151b69..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_request_body.md deleted file mode 100644 index 2bd7e9b53a9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_empty_schema.OneofWithEmptySchema(None) - try: - api_response = api_instance.post_oneof_with_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md deleted file mode 100644 index e5d9a5b9684..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_request_body.md deleted file mode 100644 index b5396a8527e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_required_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithRequiredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_required.OneofWithRequired() - try: - api_response = api_instance.post_oneof_with_required_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_required_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_response_body_for_content_types.md deleted file mode 100644 index 43cd7583d1b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/one_of_api/post_oneof_with_required_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_required_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithRequiredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import one_of_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = one_of_api.OneOfApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_required_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OneOfApi->post_oneof_with_required_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../one_of_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api.md index e54da846259..e49b4cfb7bb 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api.md @@ -9,92 +9,92 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) | -[**post_additionalproperties_are_allowed_by_default_request_body**](operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md) | -[**post_additionalproperties_can_exist_by_itself_request_body**](operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md) | -[**post_additionalproperties_should_not_look_in_applicators_request_body**](operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) | -[**post_allof_combined_with_anyof_oneof_request_body**](operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md) | -[**post_allof_request_body**](operation_request_body_api/post_allof_request_body.md) | -[**post_allof_simple_types_request_body**](operation_request_body_api/post_allof_simple_types_request_body.md) | -[**post_allof_with_base_schema_request_body**](operation_request_body_api/post_allof_with_base_schema_request_body.md) | -[**post_allof_with_one_empty_schema_request_body**](operation_request_body_api/post_allof_with_one_empty_schema_request_body.md) | -[**post_allof_with_the_first_empty_schema_request_body**](operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md) | -[**post_allof_with_the_last_empty_schema_request_body**](operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md) | -[**post_allof_with_two_empty_schemas_request_body**](operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md) | -[**post_anyof_complex_types_request_body**](operation_request_body_api/post_anyof_complex_types_request_body.md) | -[**post_anyof_request_body**](operation_request_body_api/post_anyof_request_body.md) | -[**post_anyof_with_base_schema_request_body**](operation_request_body_api/post_anyof_with_base_schema_request_body.md) | -[**post_anyof_with_one_empty_schema_request_body**](operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md) | -[**post_array_type_matches_arrays_request_body**](operation_request_body_api/post_array_type_matches_arrays_request_body.md) | -[**post_boolean_type_matches_booleans_request_body**](operation_request_body_api/post_boolean_type_matches_booleans_request_body.md) | -[**post_by_int_request_body**](operation_request_body_api/post_by_int_request_body.md) | -[**post_by_number_request_body**](operation_request_body_api/post_by_number_request_body.md) | -[**post_by_small_number_request_body**](operation_request_body_api/post_by_small_number_request_body.md) | -[**post_date_time_format_request_body**](operation_request_body_api/post_date_time_format_request_body.md) | -[**post_email_format_request_body**](operation_request_body_api/post_email_format_request_body.md) | -[**post_enum_with0_does_not_match_false_request_body**](operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md) | -[**post_enum_with1_does_not_match_true_request_body**](operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md) | -[**post_enum_with_escaped_characters_request_body**](operation_request_body_api/post_enum_with_escaped_characters_request_body.md) | -[**post_enum_with_false_does_not_match0_request_body**](operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md) | -[**post_enum_with_true_does_not_match1_request_body**](operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md) | -[**post_enums_in_properties_request_body**](operation_request_body_api/post_enums_in_properties_request_body.md) | -[**post_forbidden_property_request_body**](operation_request_body_api/post_forbidden_property_request_body.md) | -[**post_hostname_format_request_body**](operation_request_body_api/post_hostname_format_request_body.md) | -[**post_integer_type_matches_integers_request_body**](operation_request_body_api/post_integer_type_matches_integers_request_body.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) | -[**post_invalid_string_value_for_default_request_body**](operation_request_body_api/post_invalid_string_value_for_default_request_body.md) | -[**post_ipv4_format_request_body**](operation_request_body_api/post_ipv4_format_request_body.md) | -[**post_ipv6_format_request_body**](operation_request_body_api/post_ipv6_format_request_body.md) | -[**post_json_pointer_format_request_body**](operation_request_body_api/post_json_pointer_format_request_body.md) | -[**post_maximum_validation_request_body**](operation_request_body_api/post_maximum_validation_request_body.md) | -[**post_maximum_validation_with_unsigned_integer_request_body**](operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md) | -[**post_maxitems_validation_request_body**](operation_request_body_api/post_maxitems_validation_request_body.md) | -[**post_maxlength_validation_request_body**](operation_request_body_api/post_maxlength_validation_request_body.md) | -[**post_maxproperties0_means_the_object_is_empty_request_body**](operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md) | -[**post_maxproperties_validation_request_body**](operation_request_body_api/post_maxproperties_validation_request_body.md) | -[**post_minimum_validation_request_body**](operation_request_body_api/post_minimum_validation_request_body.md) | -[**post_minimum_validation_with_signed_integer_request_body**](operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md) | -[**post_minitems_validation_request_body**](operation_request_body_api/post_minitems_validation_request_body.md) | -[**post_minlength_validation_request_body**](operation_request_body_api/post_minlength_validation_request_body.md) | -[**post_minproperties_validation_request_body**](operation_request_body_api/post_minproperties_validation_request_body.md) | -[**post_nested_allof_to_check_validation_semantics_request_body**](operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md) | -[**post_nested_anyof_to_check_validation_semantics_request_body**](operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md) | -[**post_nested_items_request_body**](operation_request_body_api/post_nested_items_request_body.md) | -[**post_nested_oneof_to_check_validation_semantics_request_body**](operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md) | -[**post_not_more_complex_schema_request_body**](operation_request_body_api/post_not_more_complex_schema_request_body.md) | -[**post_not_request_body**](operation_request_body_api/post_not_request_body.md) | -[**post_nul_characters_in_strings_request_body**](operation_request_body_api/post_nul_characters_in_strings_request_body.md) | -[**post_null_type_matches_only_the_null_object_request_body**](operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md) | -[**post_number_type_matches_numbers_request_body**](operation_request_body_api/post_number_type_matches_numbers_request_body.md) | -[**post_object_properties_validation_request_body**](operation_request_body_api/post_object_properties_validation_request_body.md) | -[**post_object_type_matches_objects_request_body**](operation_request_body_api/post_object_type_matches_objects_request_body.md) | -[**post_oneof_complex_types_request_body**](operation_request_body_api/post_oneof_complex_types_request_body.md) | -[**post_oneof_request_body**](operation_request_body_api/post_oneof_request_body.md) | -[**post_oneof_with_base_schema_request_body**](operation_request_body_api/post_oneof_with_base_schema_request_body.md) | -[**post_oneof_with_empty_schema_request_body**](operation_request_body_api/post_oneof_with_empty_schema_request_body.md) | -[**post_oneof_with_required_request_body**](operation_request_body_api/post_oneof_with_required_request_body.md) | -[**post_pattern_is_not_anchored_request_body**](operation_request_body_api/post_pattern_is_not_anchored_request_body.md) | -[**post_pattern_validation_request_body**](operation_request_body_api/post_pattern_validation_request_body.md) | -[**post_properties_with_escaped_characters_request_body**](operation_request_body_api/post_properties_with_escaped_characters_request_body.md) | -[**post_property_named_ref_that_is_not_a_reference_request_body**](operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md) | -[**post_ref_in_additionalproperties_request_body**](operation_request_body_api/post_ref_in_additionalproperties_request_body.md) | -[**post_ref_in_allof_request_body**](operation_request_body_api/post_ref_in_allof_request_body.md) | -[**post_ref_in_anyof_request_body**](operation_request_body_api/post_ref_in_anyof_request_body.md) | -[**post_ref_in_items_request_body**](operation_request_body_api/post_ref_in_items_request_body.md) | -[**post_ref_in_not_request_body**](operation_request_body_api/post_ref_in_not_request_body.md) | -[**post_ref_in_oneof_request_body**](operation_request_body_api/post_ref_in_oneof_request_body.md) | -[**post_ref_in_property_request_body**](operation_request_body_api/post_ref_in_property_request_body.md) | -[**post_required_default_validation_request_body**](operation_request_body_api/post_required_default_validation_request_body.md) | -[**post_required_validation_request_body**](operation_request_body_api/post_required_validation_request_body.md) | -[**post_required_with_empty_array_request_body**](operation_request_body_api/post_required_with_empty_array_request_body.md) | -[**post_required_with_escaped_characters_request_body**](operation_request_body_api/post_required_with_escaped_characters_request_body.md) | -[**post_simple_enum_validation_request_body**](operation_request_body_api/post_simple_enum_validation_request_body.md) | -[**post_string_type_matches_strings_request_body**](operation_request_body_api/post_string_type_matches_strings_request_body.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) | -[**post_uniqueitems_false_validation_request_body**](operation_request_body_api/post_uniqueitems_false_validation_request_body.md) | -[**post_uniqueitems_validation_request_body**](operation_request_body_api/post_uniqueitems_validation_request_body.md) | -[**post_uri_format_request_body**](operation_request_body_api/post_uri_format_request_body.md) | -[**post_uri_reference_format_request_body**](operation_request_body_api/post_uri_reference_format_request_body.md) | -[**post_uri_template_format_request_body**](operation_request_body_api/post_uri_template_format_request_body.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](../../paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) | +[**post_additionalproperties_are_allowed_by_default_request_body**](../../paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) | +[**post_additionalproperties_can_exist_by_itself_request_body**](../../paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_request_body**](../../paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) | +[**post_allof_combined_with_anyof_oneof_request_body**](../../paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) | +[**post_allof_request_body**](../../paths/request_body_post_allof_request_body/post.md) | +[**post_allof_simple_types_request_body**](../../paths/request_body_post_allof_simple_types_request_body/post.md) | +[**post_allof_with_base_schema_request_body**](../../paths/request_body_post_allof_with_base_schema_request_body/post.md) | +[**post_allof_with_one_empty_schema_request_body**](../../paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) | +[**post_allof_with_the_first_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) | +[**post_allof_with_the_last_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) | +[**post_allof_with_two_empty_schemas_request_body**](../../paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) | +[**post_anyof_complex_types_request_body**](../../paths/request_body_post_anyof_complex_types_request_body/post.md) | +[**post_anyof_request_body**](../../paths/request_body_post_anyof_request_body/post.md) | +[**post_anyof_with_base_schema_request_body**](../../paths/request_body_post_anyof_with_base_schema_request_body/post.md) | +[**post_anyof_with_one_empty_schema_request_body**](../../paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) | +[**post_array_type_matches_arrays_request_body**](../../paths/request_body_post_array_type_matches_arrays_request_body/post.md) | +[**post_boolean_type_matches_booleans_request_body**](../../paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) | +[**post_by_int_request_body**](../../paths/request_body_post_by_int_request_body/post.md) | +[**post_by_number_request_body**](../../paths/request_body_post_by_number_request_body/post.md) | +[**post_by_small_number_request_body**](../../paths/request_body_post_by_small_number_request_body/post.md) | +[**post_date_time_format_request_body**](../../paths/request_body_post_date_time_format_request_body/post.md) | +[**post_email_format_request_body**](../../paths/request_body_post_email_format_request_body/post.md) | +[**post_enum_with0_does_not_match_false_request_body**](../../paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) | +[**post_enum_with1_does_not_match_true_request_body**](../../paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) | +[**post_enum_with_escaped_characters_request_body**](../../paths/request_body_post_enum_with_escaped_characters_request_body/post.md) | +[**post_enum_with_false_does_not_match0_request_body**](../../paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) | +[**post_enum_with_true_does_not_match1_request_body**](../../paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) | +[**post_enums_in_properties_request_body**](../../paths/request_body_post_enums_in_properties_request_body/post.md) | +[**post_forbidden_property_request_body**](../../paths/request_body_post_forbidden_property_request_body/post.md) | +[**post_hostname_format_request_body**](../../paths/request_body_post_hostname_format_request_body/post.md) | +[**post_integer_type_matches_integers_request_body**](../../paths/request_body_post_integer_type_matches_integers_request_body/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](../../paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) | +[**post_invalid_string_value_for_default_request_body**](../../paths/request_body_post_invalid_string_value_for_default_request_body/post.md) | +[**post_ipv4_format_request_body**](../../paths/request_body_post_ipv4_format_request_body/post.md) | +[**post_ipv6_format_request_body**](../../paths/request_body_post_ipv6_format_request_body/post.md) | +[**post_json_pointer_format_request_body**](../../paths/request_body_post_json_pointer_format_request_body/post.md) | +[**post_maximum_validation_request_body**](../../paths/request_body_post_maximum_validation_request_body/post.md) | +[**post_maximum_validation_with_unsigned_integer_request_body**](../../paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) | +[**post_maxitems_validation_request_body**](../../paths/request_body_post_maxitems_validation_request_body/post.md) | +[**post_maxlength_validation_request_body**](../../paths/request_body_post_maxlength_validation_request_body/post.md) | +[**post_maxproperties0_means_the_object_is_empty_request_body**](../../paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) | +[**post_maxproperties_validation_request_body**](../../paths/request_body_post_maxproperties_validation_request_body/post.md) | +[**post_minimum_validation_request_body**](../../paths/request_body_post_minimum_validation_request_body/post.md) | +[**post_minimum_validation_with_signed_integer_request_body**](../../paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) | +[**post_minitems_validation_request_body**](../../paths/request_body_post_minitems_validation_request_body/post.md) | +[**post_minlength_validation_request_body**](../../paths/request_body_post_minlength_validation_request_body/post.md) | +[**post_minproperties_validation_request_body**](../../paths/request_body_post_minproperties_validation_request_body/post.md) | +[**post_nested_allof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_anyof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_items_request_body**](../../paths/request_body_post_nested_items_request_body/post.md) | +[**post_nested_oneof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) | +[**post_not_more_complex_schema_request_body**](../../paths/request_body_post_not_more_complex_schema_request_body/post.md) | +[**post_not_request_body**](../../paths/request_body_post_not_request_body/post.md) | +[**post_nul_characters_in_strings_request_body**](../../paths/request_body_post_nul_characters_in_strings_request_body/post.md) | +[**post_null_type_matches_only_the_null_object_request_body**](../../paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) | +[**post_number_type_matches_numbers_request_body**](../../paths/request_body_post_number_type_matches_numbers_request_body/post.md) | +[**post_object_properties_validation_request_body**](../../paths/request_body_post_object_properties_validation_request_body/post.md) | +[**post_object_type_matches_objects_request_body**](../../paths/request_body_post_object_type_matches_objects_request_body/post.md) | +[**post_oneof_complex_types_request_body**](../../paths/request_body_post_oneof_complex_types_request_body/post.md) | +[**post_oneof_request_body**](../../paths/request_body_post_oneof_request_body/post.md) | +[**post_oneof_with_base_schema_request_body**](../../paths/request_body_post_oneof_with_base_schema_request_body/post.md) | +[**post_oneof_with_empty_schema_request_body**](../../paths/request_body_post_oneof_with_empty_schema_request_body/post.md) | +[**post_oneof_with_required_request_body**](../../paths/request_body_post_oneof_with_required_request_body/post.md) | +[**post_pattern_is_not_anchored_request_body**](../../paths/request_body_post_pattern_is_not_anchored_request_body/post.md) | +[**post_pattern_validation_request_body**](../../paths/request_body_post_pattern_validation_request_body/post.md) | +[**post_properties_with_escaped_characters_request_body**](../../paths/request_body_post_properties_with_escaped_characters_request_body/post.md) | +[**post_property_named_ref_that_is_not_a_reference_request_body**](../../paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) | +[**post_ref_in_additionalproperties_request_body**](../../paths/request_body_post_ref_in_additionalproperties_request_body/post.md) | +[**post_ref_in_allof_request_body**](../../paths/request_body_post_ref_in_allof_request_body/post.md) | +[**post_ref_in_anyof_request_body**](../../paths/request_body_post_ref_in_anyof_request_body/post.md) | +[**post_ref_in_items_request_body**](../../paths/request_body_post_ref_in_items_request_body/post.md) | +[**post_ref_in_not_request_body**](../../paths/request_body_post_ref_in_not_request_body/post.md) | +[**post_ref_in_oneof_request_body**](../../paths/request_body_post_ref_in_oneof_request_body/post.md) | +[**post_ref_in_property_request_body**](../../paths/request_body_post_ref_in_property_request_body/post.md) | +[**post_required_default_validation_request_body**](../../paths/request_body_post_required_default_validation_request_body/post.md) | +[**post_required_validation_request_body**](../../paths/request_body_post_required_validation_request_body/post.md) | +[**post_required_with_empty_array_request_body**](../../paths/request_body_post_required_with_empty_array_request_body/post.md) | +[**post_required_with_escaped_characters_request_body**](../../paths/request_body_post_required_with_escaped_characters_request_body/post.md) | +[**post_simple_enum_validation_request_body**](../../paths/request_body_post_simple_enum_validation_request_body/post.md) | +[**post_string_type_matches_strings_request_body**](../../paths/request_body_post_string_type_matches_strings_request_body/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](../../paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) | +[**post_uniqueitems_false_validation_request_body**](../../paths/request_body_post_uniqueitems_false_validation_request_body/post.md) | +[**post_uniqueitems_validation_request_body**](../../paths/request_body_post_uniqueitems_validation_request_body/post.md) | +[**post_uri_format_request_body**](../../paths/request_body_post_uri_format_request_body/post.md) | +[**post_uri_reference_format_request_body**](../../paths/request_body_post_uri_reference_format_request_body/post.md) | +[**post_uri_template_format_request_body**](../../paths/request_body_post_uri_template_format_request_body/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md deleted file mode 100644 index ca89caee25a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidate( - foo=None, - bar=None, - ) - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_additionalproperties_allows_a_schema_which_should_validate_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md deleted file mode 100644 index 51b8da4a8ac..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_are_allowed_by_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_are_allowed_by_default.AdditionalpropertiesAreAllowedByDefault(None) - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_additionalproperties_are_allowed_by_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md deleted file mode 100644 index adcf070ac7e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_can_exist_by_itself_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_can_exist_by_itself.AdditionalpropertiesCanExistByItself( - key=True, - ) - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_additionalproperties_can_exist_by_itself_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md deleted file mode 100644 index 168d16b71ec..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_additionalproperties_should_not_look_in_applicators_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_should_not_look_in_applicators.AdditionalpropertiesShouldNotLookInApplicators(None) - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_additionalproperties_should_not_look_in_applicators_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md deleted file mode 100644 index 95e8b8a5bb6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_combined_with_anyof_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofCombinedWithAnyofOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_combined_with_anyof_oneof.AllofCombinedWithAnyofOneof(None) - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_combined_with_anyof_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_request_body.md deleted file mode 100644 index 9c48d2026f7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof.Allof(None) - try: - api_response = api_instance.post_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_simple_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_simple_types_request_body.md deleted file mode 100644 index 3a02dfd6e97..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_simple_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_simple_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofSimpleTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_simple_types.AllofSimpleTypes(None) - try: - api_response = api_instance.post_allof_simple_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_simple_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_base_schema_request_body.md deleted file mode 100644 index fb4db02471c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_base_schema.AllofWithBaseSchema({}) - try: - api_response = api_instance.post_allof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_one_empty_schema_request_body.md deleted file mode 100644 index 3ed710c3b6e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_one_empty_schema.AllofWithOneEmptySchema(None) - try: - api_response = api_instance.post_allof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md deleted file mode 100644 index 070bbfdc567..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_first_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheFirstEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_first_empty_schema.AllofWithTheFirstEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_with_the_first_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md deleted file mode 100644 index d78cbf69b7a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_the_last_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheLastEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_last_empty_schema.AllofWithTheLastEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_with_the_last_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md deleted file mode 100644 index 13acfa6f571..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_allof_with_two_empty_schemas_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_two_empty_schemas_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTwoEmptySchemasRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_two_empty_schemas.AllofWithTwoEmptySchemas(None) - try: - api_response = api_instance.post_allof_with_two_empty_schemas_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_allof_with_two_empty_schemas_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_complex_types_request_body.md deleted file mode 100644 index 4289120d754..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_complex_types.AnyofComplexTypes(None) - try: - api_response = api_instance.post_anyof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_anyof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_request_body.md deleted file mode 100644 index ce57a2a4e42..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof.Anyof(None) - try: - api_response = api_instance.post_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_base_schema_request_body.md deleted file mode 100644 index 5de7b05a570..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_base_schema.AnyofWithBaseSchema("string_example") - try: - api_response = api_instance.post_anyof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_anyof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md deleted file mode 100644 index 907c4b30a71..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_anyof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_one_empty_schema.AnyofWithOneEmptySchema(None) - try: - api_response = api_instance.post_anyof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_anyof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_array_type_matches_arrays_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_array_type_matches_arrays_request_body.md deleted file mode 100644 index 5877c138745..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_array_type_matches_arrays_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_array_type_matches_arrays_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postArrayTypeMatchesArraysRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = array_type_matches_arrays.ArrayTypeMatchesArrays([ - None - ]) - try: - api_response = api_instance.post_array_type_matches_arrays_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_array_type_matches_arrays_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_boolean_type_matches_booleans_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_boolean_type_matches_booleans_request_body.md deleted file mode 100644 index 76a472c3a5d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_boolean_type_matches_booleans_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_boolean_type_matches_booleans_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBooleanTypeMatchesBooleansRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = boolean_type_matches_booleans.BooleanTypeMatchesBooleans(True) - try: - api_response = api_instance.post_boolean_type_matches_booleans_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_boolean_type_matches_booleans_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_int_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_int_request_body.md deleted file mode 100644 index c0484e70d0f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_int_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_int_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByIntRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = by_int.ByInt(None) - try: - api_response = api_instance.post_by_int_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_by_int_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_number_request_body.md deleted file mode 100644 index cde67d41dc1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = by_number.ByNumber(None) - try: - api_response = api_instance.post_by_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_by_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_small_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_small_number_request_body.md deleted file mode 100644 index 5ef9fb99259..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_by_small_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_small_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBySmallNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = by_small_number.BySmallNumber(None) - try: - api_response = api_instance.post_by_small_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_by_small_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_date_time_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_date_time_format_request_body.md deleted file mode 100644 index 44935398a1b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_date_time_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_date_time_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postDateTimeFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = date_time_format.DateTimeFormat(None) - try: - api_response = api_instance.post_date_time_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_date_time_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_email_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_email_format_request_body.md deleted file mode 100644 index 9e9e998bf21..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_email_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_email_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEmailFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = email_format.EmailFormat(None) - try: - api_response = api_instance.post_email_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_email_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md deleted file mode 100644 index 83a0168c5d3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with0_does_not_match_false_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with0_does_not_match_false_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith0DoesNotMatchFalseRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with0_does_not_match_false.EnumWith0DoesNotMatchFalse(0) - try: - api_response = api_instance.post_enum_with0_does_not_match_false_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enum_with0_does_not_match_false_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md deleted file mode 100644 index 3eb77108913..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with1_does_not_match_true_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with1_does_not_match_true_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith1DoesNotMatchTrueRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with1_does_not_match_true.EnumWith1DoesNotMatchTrue(1) - try: - api_response = api_instance.post_enum_with1_does_not_match_true_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enum_with1_does_not_match_true_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_escaped_characters_request_body.md deleted file mode 100644 index 845aed81994..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_escaped_characters.EnumWithEscapedCharacters("foo\nbar") - try: - api_response = api_instance.post_enum_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enum_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md deleted file mode 100644 index 8620e8ef6f2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_false_does_not_match0_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_false_does_not_match0_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithFalseDoesNotMatch0RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_false_does_not_match0.EnumWithFalseDoesNotMatch0(False) - try: - api_response = api_instance.post_enum_with_false_does_not_match0_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enum_with_false_does_not_match0_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md deleted file mode 100644 index 77b055766b7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enum_with_true_does_not_match1_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_true_does_not_match1_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithTrueDoesNotMatch1RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_true_does_not_match1.EnumWithTrueDoesNotMatch1(True) - try: - api_response = api_instance.post_enum_with_true_does_not_match1_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enum_with_true_does_not_match1_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enums_in_properties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enums_in_properties_request_body.md deleted file mode 100644 index 2efa35ae26b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_enums_in_properties_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_enums_in_properties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumsInPropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = enums_in_properties.EnumsInProperties( - foo="foo", - bar="bar", - ) - try: - api_response = api_instance.post_enums_in_properties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_enums_in_properties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_forbidden_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_forbidden_property_request_body.md deleted file mode 100644 index 7731b4680a5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_forbidden_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_forbidden_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postForbiddenPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = forbidden_property.ForbiddenProperty(None) - try: - api_response = api_instance.post_forbidden_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_forbidden_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_hostname_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_hostname_format_request_body.md deleted file mode 100644 index a9cd8d094c4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_hostname_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_hostname_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postHostnameFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = hostname_format.HostnameFormat(None) - try: - api_response = api_instance.post_hostname_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_hostname_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_integer_type_matches_integers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_integer_type_matches_integers_request_body.md deleted file mode 100644 index b8e2134ec95..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_integer_type_matches_integers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_integer_type_matches_integers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIntegerTypeMatchesIntegersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = integer_type_matches_integers.IntegerTypeMatchesIntegers(1) - try: - api_response = api_instance.post_integer_type_matches_integers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_integer_type_matches_integers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md deleted file mode 100644 index b1898276002..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_instance_should_not_raise_error_when_float_division_inf.InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf(1) - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_string_value_for_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_string_value_for_default_request_body.md deleted file mode 100644 index 6e1852c1c78..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_invalid_string_value_for_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_string_value_for_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidStringValueForDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_string_value_for_default.InvalidStringValueForDefault(None) - try: - api_response = api_instance.post_invalid_string_value_for_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_invalid_string_value_for_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv4_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv4_format_request_body.md deleted file mode 100644 index a3a3ab5b55e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv4_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv4_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv4FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv4_format.Ipv4Format(None) - try: - api_response = api_instance.post_ipv4_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ipv4_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv6_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv6_format_request_body.md deleted file mode 100644 index a0099bfe41b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ipv6_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv6_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv6FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv6_format.Ipv6Format(None) - try: - api_response = api_instance.post_ipv6_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ipv6_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_json_pointer_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_json_pointer_format_request_body.md deleted file mode 100644 index 8c98097e8fe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_json_pointer_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_json_pointer_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postJsonPointerFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = json_pointer_format.JsonPointerFormat(None) - try: - api_response = api_instance.post_json_pointer_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_json_pointer_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_request_body.md deleted file mode 100644 index 8b34cd009e2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation.MaximumValidation(None) - try: - api_response = api_instance.post_maximum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maximum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md deleted file mode 100644 index 7c92dc491c8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maximum_validation_with_unsigned_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation_with_unsigned_integer.MaximumValidationWithUnsignedInteger(None) - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maximum_validation_with_unsigned_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxitems_validation_request_body.md deleted file mode 100644 index 7a9e75aa573..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maxitems_validation.MaxitemsValidation(None) - try: - api_response = api_instance.post_maxitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maxitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxlength_validation_request_body.md deleted file mode 100644 index 0daa4b87206..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maxlength_validation.MaxlengthValidation(None) - try: - api_response = api_instance.post_maxlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maxlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md deleted file mode 100644 index 48b372f229b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties0_means_the_object_is_empty_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties0_means_the_object_is_empty.Maxproperties0MeansTheObjectIsEmpty(None) - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maxproperties0_means_the_object_is_empty_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties_validation_request_body.md deleted file mode 100644 index b70eaa930bb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_maxproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties_validation.MaxpropertiesValidation(None) - try: - api_response = api_instance.post_maxproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_maxproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_request_body.md deleted file mode 100644 index 0bea3623296..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation.MinimumValidation(None) - try: - api_response = api_instance.post_minimum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_minimum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md deleted file mode 100644 index faec3e472dd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minimum_validation_with_signed_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationWithSignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation_with_signed_integer.MinimumValidationWithSignedInteger(None) - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_minimum_validation_with_signed_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minitems_validation_request_body.md deleted file mode 100644 index 0a6442680b5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = minitems_validation.MinitemsValidation(None) - try: - api_response = api_instance.post_minitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_minitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minlength_validation_request_body.md deleted file mode 100644 index 4378cd3c0f3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = minlength_validation.MinlengthValidation(None) - try: - api_response = api_instance.post_minlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_minlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minproperties_validation_request_body.md deleted file mode 100644 index e749d292076..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_minproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = minproperties_validation.MinpropertiesValidation(None) - try: - api_response = api_instance.post_minproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_minproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 45955479d7a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_allof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_allof_to_check_validation_semantics.NestedAllofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_nested_allof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 64c469156a3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_anyof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_anyof_to_check_validation_semantics.NestedAnyofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_nested_anyof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_items_request_body.md deleted file mode 100644 index a27209f0679..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_items_request_body.md +++ /dev/null @@ -1,106 +0,0 @@ - -# **post_nested_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_items.NestedItems([ - [ - [ - [ - 3.14 - ] - ] - ] - ]) - try: - api_response = api_instance.post_nested_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_nested_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md deleted file mode 100644 index eafee84e3c2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nested_oneof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_oneof_to_check_validation_semantics.NestedOneofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_nested_oneof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_more_complex_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_more_complex_schema_request_body.md deleted file mode 100644 index 3d682f935ea..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_more_complex_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_more_complex_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotMoreComplexSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = not_more_complex_schema.NotMoreComplexSchema(None) - try: - api_response = api_instance.post_not_more_complex_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_not_more_complex_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_request_body.md deleted file mode 100644 index bd35a10dc16..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = _not._Not(None) - try: - api_response = api_instance.post_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nul_characters_in_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nul_characters_in_strings_request_body.md deleted file mode 100644 index 373d6805615..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_nul_characters_in_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nul_characters_in_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNulCharactersInStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = nul_characters_in_strings.NulCharactersInStrings("hello\x00there") - try: - api_response = api_instance.post_nul_characters_in_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_nul_characters_in_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md deleted file mode 100644 index 9b3bafe832c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_null_type_matches_only_the_null_object_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), None] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = null_type_matches_only_the_null_object.NullTypeMatchesOnlyTheNullObject(None) - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_null_type_matches_only_the_null_object_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_number_type_matches_numbers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_number_type_matches_numbers_request_body.md deleted file mode 100644 index cb0f8c1631f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_number_type_matches_numbers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_number_type_matches_numbers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNumberTypeMatchesNumbersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = number_type_matches_numbers.NumberTypeMatchesNumbers(3.14) - try: - api_response = api_instance.post_number_type_matches_numbers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_number_type_matches_numbers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_properties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_properties_validation_request_body.md deleted file mode 100644 index 4e694b3db1b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_properties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_properties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectPropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = object_properties_validation.ObjectPropertiesValidation(None) - try: - api_response = api_instance.post_object_properties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_object_properties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_type_matches_objects_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_type_matches_objects_request_body.md deleted file mode 100644 index 226064cb221..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_object_type_matches_objects_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_type_matches_objects_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectTypeMatchesObjectsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = object_type_matches_objects.ObjectTypeMatchesObjects() - try: - api_response = api_instance.post_object_type_matches_objects_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_object_type_matches_objects_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_complex_types_request_body.md deleted file mode 100644 index 5f4b9d0725c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_complex_types.OneofComplexTypes(None) - try: - api_response = api_instance.post_oneof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_oneof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_request_body.md deleted file mode 100644 index 624508de6f9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof.Oneof(None) - try: - api_response = api_instance.post_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_base_schema_request_body.md deleted file mode 100644 index 348a1c24b8b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_base_schema.OneofWithBaseSchema("string_example") - try: - api_response = api_instance.post_oneof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_oneof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_empty_schema_request_body.md deleted file mode 100644 index 0fbd1d7baa1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_empty_schema.OneofWithEmptySchema(None) - try: - api_response = api_instance.post_oneof_with_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_oneof_with_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_required_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_required_request_body.md deleted file mode 100644 index 869660089dd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_oneof_with_required_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_required_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithRequiredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_required.OneofWithRequired() - try: - api_response = api_instance.post_oneof_with_required_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_oneof_with_required_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_is_not_anchored_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_is_not_anchored_request_body.md deleted file mode 100644 index 03a9e7e7690..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_is_not_anchored_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_is_not_anchored_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternIsNotAnchoredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_is_not_anchored.PatternIsNotAnchored(None) - try: - api_response = api_instance.post_pattern_is_not_anchored_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_pattern_is_not_anchored_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_validation_request_body.md deleted file mode 100644 index 2ab0188b430..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_pattern_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_validation.PatternValidation(None) - try: - api_response = api_instance.post_pattern_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_pattern_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_properties_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_properties_with_escaped_characters_request_body.md deleted file mode 100644 index 84efe2663a4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_properties_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_properties_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertiesWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = properties_with_escaped_characters.PropertiesWithEscapedCharacters(None) - try: - api_response = api_instance.post_properties_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_properties_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md deleted file mode 100644 index 42472b80b90..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_property_named_ref_that_is_not_a_reference_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_property_named_ref_that_is_not_a_reference_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_additionalproperties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_additionalproperties_request_body.md deleted file mode 100644 index bd47b2c4b69..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_additionalproperties_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_additionalproperties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAdditionalpropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_additionalproperties.RefInAdditionalproperties( - key=property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None), - ) - try: - api_response = api_instance.post_ref_in_additionalproperties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_additionalproperties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_allof_request_body.md deleted file mode 100644 index 656d29e8c34..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_allof.RefInAllof(None) - try: - api_response = api_instance.post_ref_in_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_anyof_request_body.md deleted file mode 100644 index b7a71339050..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_anyof.RefInAnyof(None) - try: - api_response = api_instance.post_ref_in_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_items_request_body.md deleted file mode 100644 index 1934d510449..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_items_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_items.RefInItems([ - property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - ]) - try: - api_response = api_instance.post_ref_in_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_not_request_body.md deleted file mode 100644 index c52566b7172..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_not.RefInNot(None) - try: - api_response = api_instance.post_ref_in_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_oneof_request_body.md deleted file mode 100644 index 7a8d567ff84..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_oneof.RefInOneof(None) - try: - api_response = api_instance.post_ref_in_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_property_request_body.md deleted file mode 100644 index 3cef64d4134..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_ref_in_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_property.RefInProperty(None) - try: - api_response = api_instance.post_ref_in_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_ref_in_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_default_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_default_validation_request_body.md deleted file mode 100644 index 5f8708b33a8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_default_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_default_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredDefaultValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = required_default_validation.RequiredDefaultValidation(None) - try: - api_response = api_instance.post_required_default_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_required_default_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_validation_request_body.md deleted file mode 100644 index 81d5fc1cc73..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = required_validation.RequiredValidation(None) - try: - api_response = api_instance.post_required_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_required_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_empty_array_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_empty_array_request_body.md deleted file mode 100644 index 482abdb38ab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_empty_array_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_empty_array_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEmptyArrayRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_empty_array.RequiredWithEmptyArray(None) - try: - api_response = api_instance.post_required_with_empty_array_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_required_with_empty_array_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_escaped_characters_request_body.md deleted file mode 100644 index dc0fc94996b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_required_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_escaped_characters.RequiredWithEscapedCharacters(None) - try: - api_response = api_instance.post_required_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_required_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_simple_enum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_simple_enum_validation_request_body.md deleted file mode 100644 index 27c61d80c8e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_simple_enum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_simple_enum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postSimpleEnumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = simple_enum_validation.SimpleEnumValidation(1) - try: - api_response = api_instance.post_simple_enum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_simple_enum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_string_type_matches_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_string_type_matches_strings_request_body.md deleted file mode 100644 index cadfdf0007c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_string_type_matches_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_string_type_matches_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postStringTypeMatchesStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = string_type_matches_strings.StringTypeMatchesStrings("string_example") - try: - api_response = api_instance.post_string_type_matches_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_string_type_matches_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md deleted file mode 100644 index 36f57177fe9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = the_default_keyword_does_not_do_anything_if_the_property_is_missing.TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing( - alpha=5, - ) - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_false_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_false_validation_request_body.md deleted file mode 100644 index 0a9352b6291..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_false_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_false_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsFalseValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_false_validation.UniqueitemsFalseValidation(None) - try: - api_response = api_instance.post_uniqueitems_false_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_uniqueitems_false_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_validation_request_body.md deleted file mode 100644 index a2c977ea13f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uniqueitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_validation.UniqueitemsValidation(None) - try: - api_response = api_instance.post_uniqueitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_uniqueitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_format_request_body.md deleted file mode 100644 index 315714f169a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_format.UriFormat(None) - try: - api_response = api_instance.post_uri_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_uri_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_reference_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_reference_format_request_body.md deleted file mode 100644 index 6aa3eebbacb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_reference_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_reference_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriReferenceFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_reference_format.UriReferenceFormat(None) - try: - api_response = api_instance.post_uri_reference_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_uri_reference_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_template_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_template_format_request_body.md deleted file mode 100644 index e3f5944b509..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/operation_request_body_api/post_uri_template_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_template_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriTemplateFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import operation_request_body_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_template_format.UriTemplateFormat(None) - try: - api_response = api_instance.post_uri_template_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling OperationRequestBodyApi->post_uri_template_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../operation_request_body_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api.md index afb3403a15d..72bc6e90636 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api.md @@ -9,179 +9,179 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md) | -[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) | -[**post_additionalproperties_are_allowed_by_default_request_body**](path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md) | -[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) | -[**post_additionalproperties_can_exist_by_itself_request_body**](path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md) | -[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) | -[**post_additionalproperties_should_not_look_in_applicators_request_body**](path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md) | -[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) | -[**post_allof_combined_with_anyof_oneof_request_body**](path_post_api/post_allof_combined_with_anyof_oneof_request_body.md) | -[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) | -[**post_allof_request_body**](path_post_api/post_allof_request_body.md) | -[**post_allof_response_body_for_content_types**](path_post_api/post_allof_response_body_for_content_types.md) | -[**post_allof_simple_types_request_body**](path_post_api/post_allof_simple_types_request_body.md) | -[**post_allof_simple_types_response_body_for_content_types**](path_post_api/post_allof_simple_types_response_body_for_content_types.md) | -[**post_allof_with_base_schema_request_body**](path_post_api/post_allof_with_base_schema_request_body.md) | -[**post_allof_with_base_schema_response_body_for_content_types**](path_post_api/post_allof_with_base_schema_response_body_for_content_types.md) | -[**post_allof_with_one_empty_schema_request_body**](path_post_api/post_allof_with_one_empty_schema_request_body.md) | -[**post_allof_with_one_empty_schema_response_body_for_content_types**](path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_first_empty_schema_request_body**](path_post_api/post_allof_with_the_first_empty_schema_request_body.md) | -[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_last_empty_schema_request_body**](path_post_api/post_allof_with_the_last_empty_schema_request_body.md) | -[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_two_empty_schemas_request_body**](path_post_api/post_allof_with_two_empty_schemas_request_body.md) | -[**post_allof_with_two_empty_schemas_response_body_for_content_types**](path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) | -[**post_anyof_complex_types_request_body**](path_post_api/post_anyof_complex_types_request_body.md) | -[**post_anyof_complex_types_response_body_for_content_types**](path_post_api/post_anyof_complex_types_response_body_for_content_types.md) | -[**post_anyof_request_body**](path_post_api/post_anyof_request_body.md) | -[**post_anyof_response_body_for_content_types**](path_post_api/post_anyof_response_body_for_content_types.md) | -[**post_anyof_with_base_schema_request_body**](path_post_api/post_anyof_with_base_schema_request_body.md) | -[**post_anyof_with_base_schema_response_body_for_content_types**](path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md) | -[**post_anyof_with_one_empty_schema_request_body**](path_post_api/post_anyof_with_one_empty_schema_request_body.md) | -[**post_anyof_with_one_empty_schema_response_body_for_content_types**](path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_array_type_matches_arrays_request_body**](path_post_api/post_array_type_matches_arrays_request_body.md) | -[**post_array_type_matches_arrays_response_body_for_content_types**](path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md) | -[**post_boolean_type_matches_booleans_request_body**](path_post_api/post_boolean_type_matches_booleans_request_body.md) | -[**post_boolean_type_matches_booleans_response_body_for_content_types**](path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) | -[**post_by_int_request_body**](path_post_api/post_by_int_request_body.md) | -[**post_by_int_response_body_for_content_types**](path_post_api/post_by_int_response_body_for_content_types.md) | -[**post_by_number_request_body**](path_post_api/post_by_number_request_body.md) | -[**post_by_number_response_body_for_content_types**](path_post_api/post_by_number_response_body_for_content_types.md) | -[**post_by_small_number_request_body**](path_post_api/post_by_small_number_request_body.md) | -[**post_by_small_number_response_body_for_content_types**](path_post_api/post_by_small_number_response_body_for_content_types.md) | -[**post_date_time_format_request_body**](path_post_api/post_date_time_format_request_body.md) | -[**post_date_time_format_response_body_for_content_types**](path_post_api/post_date_time_format_response_body_for_content_types.md) | -[**post_email_format_request_body**](path_post_api/post_email_format_request_body.md) | -[**post_email_format_response_body_for_content_types**](path_post_api/post_email_format_response_body_for_content_types.md) | -[**post_enum_with0_does_not_match_false_request_body**](path_post_api/post_enum_with0_does_not_match_false_request_body.md) | -[**post_enum_with0_does_not_match_false_response_body_for_content_types**](path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) | -[**post_enum_with1_does_not_match_true_request_body**](path_post_api/post_enum_with1_does_not_match_true_request_body.md) | -[**post_enum_with1_does_not_match_true_response_body_for_content_types**](path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) | -[**post_enum_with_escaped_characters_request_body**](path_post_api/post_enum_with_escaped_characters_request_body.md) | -[**post_enum_with_escaped_characters_response_body_for_content_types**](path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md) | -[**post_enum_with_false_does_not_match0_request_body**](path_post_api/post_enum_with_false_does_not_match0_request_body.md) | -[**post_enum_with_false_does_not_match0_response_body_for_content_types**](path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) | -[**post_enum_with_true_does_not_match1_request_body**](path_post_api/post_enum_with_true_does_not_match1_request_body.md) | -[**post_enum_with_true_does_not_match1_response_body_for_content_types**](path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) | -[**post_enums_in_properties_request_body**](path_post_api/post_enums_in_properties_request_body.md) | -[**post_enums_in_properties_response_body_for_content_types**](path_post_api/post_enums_in_properties_response_body_for_content_types.md) | -[**post_forbidden_property_request_body**](path_post_api/post_forbidden_property_request_body.md) | -[**post_forbidden_property_response_body_for_content_types**](path_post_api/post_forbidden_property_response_body_for_content_types.md) | -[**post_hostname_format_request_body**](path_post_api/post_hostname_format_request_body.md) | -[**post_hostname_format_response_body_for_content_types**](path_post_api/post_hostname_format_response_body_for_content_types.md) | -[**post_integer_type_matches_integers_request_body**](path_post_api/post_integer_type_matches_integers_request_body.md) | -[**post_integer_type_matches_integers_response_body_for_content_types**](path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) | -[**post_invalid_string_value_for_default_request_body**](path_post_api/post_invalid_string_value_for_default_request_body.md) | -[**post_invalid_string_value_for_default_response_body_for_content_types**](path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md) | -[**post_ipv4_format_request_body**](path_post_api/post_ipv4_format_request_body.md) | -[**post_ipv4_format_response_body_for_content_types**](path_post_api/post_ipv4_format_response_body_for_content_types.md) | -[**post_ipv6_format_request_body**](path_post_api/post_ipv6_format_request_body.md) | -[**post_ipv6_format_response_body_for_content_types**](path_post_api/post_ipv6_format_response_body_for_content_types.md) | -[**post_json_pointer_format_request_body**](path_post_api/post_json_pointer_format_request_body.md) | -[**post_json_pointer_format_response_body_for_content_types**](path_post_api/post_json_pointer_format_response_body_for_content_types.md) | -[**post_maximum_validation_request_body**](path_post_api/post_maximum_validation_request_body.md) | -[**post_maximum_validation_response_body_for_content_types**](path_post_api/post_maximum_validation_response_body_for_content_types.md) | -[**post_maximum_validation_with_unsigned_integer_request_body**](path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md) | -[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) | -[**post_maxitems_validation_request_body**](path_post_api/post_maxitems_validation_request_body.md) | -[**post_maxitems_validation_response_body_for_content_types**](path_post_api/post_maxitems_validation_response_body_for_content_types.md) | -[**post_maxlength_validation_request_body**](path_post_api/post_maxlength_validation_request_body.md) | -[**post_maxlength_validation_response_body_for_content_types**](path_post_api/post_maxlength_validation_response_body_for_content_types.md) | -[**post_maxproperties0_means_the_object_is_empty_request_body**](path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md) | -[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) | -[**post_maxproperties_validation_request_body**](path_post_api/post_maxproperties_validation_request_body.md) | -[**post_maxproperties_validation_response_body_for_content_types**](path_post_api/post_maxproperties_validation_response_body_for_content_types.md) | -[**post_minimum_validation_request_body**](path_post_api/post_minimum_validation_request_body.md) | -[**post_minimum_validation_response_body_for_content_types**](path_post_api/post_minimum_validation_response_body_for_content_types.md) | -[**post_minimum_validation_with_signed_integer_request_body**](path_post_api/post_minimum_validation_with_signed_integer_request_body.md) | -[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) | -[**post_minitems_validation_request_body**](path_post_api/post_minitems_validation_request_body.md) | -[**post_minitems_validation_response_body_for_content_types**](path_post_api/post_minitems_validation_response_body_for_content_types.md) | -[**post_minlength_validation_request_body**](path_post_api/post_minlength_validation_request_body.md) | -[**post_minlength_validation_response_body_for_content_types**](path_post_api/post_minlength_validation_response_body_for_content_types.md) | -[**post_minproperties_validation_request_body**](path_post_api/post_minproperties_validation_request_body.md) | -[**post_minproperties_validation_response_body_for_content_types**](path_post_api/post_minproperties_validation_response_body_for_content_types.md) | -[**post_nested_allof_to_check_validation_semantics_request_body**](path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md) | -[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_anyof_to_check_validation_semantics_request_body**](path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md) | -[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_items_request_body**](path_post_api/post_nested_items_request_body.md) | -[**post_nested_items_response_body_for_content_types**](path_post_api/post_nested_items_response_body_for_content_types.md) | -[**post_nested_oneof_to_check_validation_semantics_request_body**](path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md) | -[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_not_more_complex_schema_request_body**](path_post_api/post_not_more_complex_schema_request_body.md) | -[**post_not_more_complex_schema_response_body_for_content_types**](path_post_api/post_not_more_complex_schema_response_body_for_content_types.md) | -[**post_not_request_body**](path_post_api/post_not_request_body.md) | -[**post_not_response_body_for_content_types**](path_post_api/post_not_response_body_for_content_types.md) | -[**post_nul_characters_in_strings_request_body**](path_post_api/post_nul_characters_in_strings_request_body.md) | -[**post_nul_characters_in_strings_response_body_for_content_types**](path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md) | -[**post_null_type_matches_only_the_null_object_request_body**](path_post_api/post_null_type_matches_only_the_null_object_request_body.md) | -[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) | -[**post_number_type_matches_numbers_request_body**](path_post_api/post_number_type_matches_numbers_request_body.md) | -[**post_number_type_matches_numbers_response_body_for_content_types**](path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md) | -[**post_object_properties_validation_request_body**](path_post_api/post_object_properties_validation_request_body.md) | -[**post_object_properties_validation_response_body_for_content_types**](path_post_api/post_object_properties_validation_response_body_for_content_types.md) | -[**post_object_type_matches_objects_request_body**](path_post_api/post_object_type_matches_objects_request_body.md) | -[**post_object_type_matches_objects_response_body_for_content_types**](path_post_api/post_object_type_matches_objects_response_body_for_content_types.md) | -[**post_oneof_complex_types_request_body**](path_post_api/post_oneof_complex_types_request_body.md) | -[**post_oneof_complex_types_response_body_for_content_types**](path_post_api/post_oneof_complex_types_response_body_for_content_types.md) | -[**post_oneof_request_body**](path_post_api/post_oneof_request_body.md) | -[**post_oneof_response_body_for_content_types**](path_post_api/post_oneof_response_body_for_content_types.md) | -[**post_oneof_with_base_schema_request_body**](path_post_api/post_oneof_with_base_schema_request_body.md) | -[**post_oneof_with_base_schema_response_body_for_content_types**](path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md) | -[**post_oneof_with_empty_schema_request_body**](path_post_api/post_oneof_with_empty_schema_request_body.md) | -[**post_oneof_with_empty_schema_response_body_for_content_types**](path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md) | -[**post_oneof_with_required_request_body**](path_post_api/post_oneof_with_required_request_body.md) | -[**post_oneof_with_required_response_body_for_content_types**](path_post_api/post_oneof_with_required_response_body_for_content_types.md) | -[**post_pattern_is_not_anchored_request_body**](path_post_api/post_pattern_is_not_anchored_request_body.md) | -[**post_pattern_is_not_anchored_response_body_for_content_types**](path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md) | -[**post_pattern_validation_request_body**](path_post_api/post_pattern_validation_request_body.md) | -[**post_pattern_validation_response_body_for_content_types**](path_post_api/post_pattern_validation_response_body_for_content_types.md) | -[**post_properties_with_escaped_characters_request_body**](path_post_api/post_properties_with_escaped_characters_request_body.md) | -[**post_properties_with_escaped_characters_response_body_for_content_types**](path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md) | -[**post_property_named_ref_that_is_not_a_reference_request_body**](path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md) | -[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) | -[**post_ref_in_additionalproperties_request_body**](path_post_api/post_ref_in_additionalproperties_request_body.md) | -[**post_ref_in_additionalproperties_response_body_for_content_types**](path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md) | -[**post_ref_in_allof_request_body**](path_post_api/post_ref_in_allof_request_body.md) | -[**post_ref_in_allof_response_body_for_content_types**](path_post_api/post_ref_in_allof_response_body_for_content_types.md) | -[**post_ref_in_anyof_request_body**](path_post_api/post_ref_in_anyof_request_body.md) | -[**post_ref_in_anyof_response_body_for_content_types**](path_post_api/post_ref_in_anyof_response_body_for_content_types.md) | -[**post_ref_in_items_request_body**](path_post_api/post_ref_in_items_request_body.md) | -[**post_ref_in_items_response_body_for_content_types**](path_post_api/post_ref_in_items_response_body_for_content_types.md) | -[**post_ref_in_not_request_body**](path_post_api/post_ref_in_not_request_body.md) | -[**post_ref_in_not_response_body_for_content_types**](path_post_api/post_ref_in_not_response_body_for_content_types.md) | -[**post_ref_in_oneof_request_body**](path_post_api/post_ref_in_oneof_request_body.md) | -[**post_ref_in_oneof_response_body_for_content_types**](path_post_api/post_ref_in_oneof_response_body_for_content_types.md) | -[**post_ref_in_property_request_body**](path_post_api/post_ref_in_property_request_body.md) | -[**post_ref_in_property_response_body_for_content_types**](path_post_api/post_ref_in_property_response_body_for_content_types.md) | -[**post_required_default_validation_request_body**](path_post_api/post_required_default_validation_request_body.md) | -[**post_required_default_validation_response_body_for_content_types**](path_post_api/post_required_default_validation_response_body_for_content_types.md) | -[**post_required_validation_request_body**](path_post_api/post_required_validation_request_body.md) | -[**post_required_validation_response_body_for_content_types**](path_post_api/post_required_validation_response_body_for_content_types.md) | -[**post_required_with_empty_array_request_body**](path_post_api/post_required_with_empty_array_request_body.md) | -[**post_required_with_empty_array_response_body_for_content_types**](path_post_api/post_required_with_empty_array_response_body_for_content_types.md) | -[**post_required_with_escaped_characters_request_body**](path_post_api/post_required_with_escaped_characters_request_body.md) | -[**post_required_with_escaped_characters_response_body_for_content_types**](path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md) | -[**post_simple_enum_validation_request_body**](path_post_api/post_simple_enum_validation_request_body.md) | -[**post_simple_enum_validation_response_body_for_content_types**](path_post_api/post_simple_enum_validation_response_body_for_content_types.md) | -[**post_string_type_matches_strings_request_body**](path_post_api/post_string_type_matches_strings_request_body.md) | -[**post_string_type_matches_strings_response_body_for_content_types**](path_post_api/post_string_type_matches_strings_response_body_for_content_types.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) | -[**post_uniqueitems_false_validation_request_body**](path_post_api/post_uniqueitems_false_validation_request_body.md) | -[**post_uniqueitems_false_validation_response_body_for_content_types**](path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md) | -[**post_uniqueitems_validation_request_body**](path_post_api/post_uniqueitems_validation_request_body.md) | -[**post_uniqueitems_validation_response_body_for_content_types**](path_post_api/post_uniqueitems_validation_response_body_for_content_types.md) | -[**post_uri_format_request_body**](path_post_api/post_uri_format_request_body.md) | -[**post_uri_format_response_body_for_content_types**](path_post_api/post_uri_format_response_body_for_content_types.md) | -[**post_uri_reference_format_request_body**](path_post_api/post_uri_reference_format_request_body.md) | -[**post_uri_reference_format_response_body_for_content_types**](path_post_api/post_uri_reference_format_response_body_for_content_types.md) | -[**post_uri_template_format_request_body**](path_post_api/post_uri_template_format_request_body.md) | -[**post_uri_template_format_response_body_for_content_types**](path_post_api/post_uri_template_format_response_body_for_content_types.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_request_body**](../../paths/request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body/post.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) | +[**post_additionalproperties_are_allowed_by_default_request_body**](../../paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md) | +[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) | +[**post_additionalproperties_can_exist_by_itself_request_body**](../../paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md) | +[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_request_body**](../../paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) | +[**post_allof_combined_with_anyof_oneof_request_body**](../../paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md) | +[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](../../paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) | +[**post_allof_request_body**](../../paths/request_body_post_allof_request_body/post.md) | +[**post_allof_response_body_for_content_types**](../../paths/response_body_post_allof_response_body_for_content_types/post.md) | +[**post_allof_simple_types_request_body**](../../paths/request_body_post_allof_simple_types_request_body/post.md) | +[**post_allof_simple_types_response_body_for_content_types**](../../paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) | +[**post_allof_with_base_schema_request_body**](../../paths/request_body_post_allof_with_base_schema_request_body/post.md) | +[**post_allof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) | +[**post_allof_with_one_empty_schema_request_body**](../../paths/request_body_post_allof_with_one_empty_schema_request_body/post.md) | +[**post_allof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_first_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md) | +[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_last_empty_schema_request_body**](../../paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md) | +[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_two_empty_schemas_request_body**](../../paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md) | +[**post_allof_with_two_empty_schemas_response_body_for_content_types**](../../paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) | +[**post_anyof_complex_types_request_body**](../../paths/request_body_post_anyof_complex_types_request_body/post.md) | +[**post_anyof_complex_types_response_body_for_content_types**](../../paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) | +[**post_anyof_request_body**](../../paths/request_body_post_anyof_request_body/post.md) | +[**post_anyof_response_body_for_content_types**](../../paths/response_body_post_anyof_response_body_for_content_types/post.md) | +[**post_anyof_with_base_schema_request_body**](../../paths/request_body_post_anyof_with_base_schema_request_body/post.md) | +[**post_anyof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) | +[**post_anyof_with_one_empty_schema_request_body**](../../paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md) | +[**post_anyof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_array_type_matches_arrays_request_body**](../../paths/request_body_post_array_type_matches_arrays_request_body/post.md) | +[**post_array_type_matches_arrays_response_body_for_content_types**](../../paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) | +[**post_boolean_type_matches_booleans_request_body**](../../paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) | +[**post_boolean_type_matches_booleans_response_body_for_content_types**](../../paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) | +[**post_by_int_request_body**](../../paths/request_body_post_by_int_request_body/post.md) | +[**post_by_int_response_body_for_content_types**](../../paths/response_body_post_by_int_response_body_for_content_types/post.md) | +[**post_by_number_request_body**](../../paths/request_body_post_by_number_request_body/post.md) | +[**post_by_number_response_body_for_content_types**](../../paths/response_body_post_by_number_response_body_for_content_types/post.md) | +[**post_by_small_number_request_body**](../../paths/request_body_post_by_small_number_request_body/post.md) | +[**post_by_small_number_response_body_for_content_types**](../../paths/response_body_post_by_small_number_response_body_for_content_types/post.md) | +[**post_date_time_format_request_body**](../../paths/request_body_post_date_time_format_request_body/post.md) | +[**post_date_time_format_response_body_for_content_types**](../../paths/response_body_post_date_time_format_response_body_for_content_types/post.md) | +[**post_email_format_request_body**](../../paths/request_body_post_email_format_request_body/post.md) | +[**post_email_format_response_body_for_content_types**](../../paths/response_body_post_email_format_response_body_for_content_types/post.md) | +[**post_enum_with0_does_not_match_false_request_body**](../../paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md) | +[**post_enum_with0_does_not_match_false_response_body_for_content_types**](../../paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) | +[**post_enum_with1_does_not_match_true_request_body**](../../paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md) | +[**post_enum_with1_does_not_match_true_response_body_for_content_types**](../../paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) | +[**post_enum_with_escaped_characters_request_body**](../../paths/request_body_post_enum_with_escaped_characters_request_body/post.md) | +[**post_enum_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_enum_with_false_does_not_match0_request_body**](../../paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md) | +[**post_enum_with_false_does_not_match0_response_body_for_content_types**](../../paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) | +[**post_enum_with_true_does_not_match1_request_body**](../../paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md) | +[**post_enum_with_true_does_not_match1_response_body_for_content_types**](../../paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) | +[**post_enums_in_properties_request_body**](../../paths/request_body_post_enums_in_properties_request_body/post.md) | +[**post_enums_in_properties_response_body_for_content_types**](../../paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) | +[**post_forbidden_property_request_body**](../../paths/request_body_post_forbidden_property_request_body/post.md) | +[**post_forbidden_property_response_body_for_content_types**](../../paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) | +[**post_hostname_format_request_body**](../../paths/request_body_post_hostname_format_request_body/post.md) | +[**post_hostname_format_response_body_for_content_types**](../../paths/response_body_post_hostname_format_response_body_for_content_types/post.md) | +[**post_integer_type_matches_integers_request_body**](../../paths/request_body_post_integer_type_matches_integers_request_body/post.md) | +[**post_integer_type_matches_integers_response_body_for_content_types**](../../paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body**](../../paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](../../paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) | +[**post_invalid_string_value_for_default_request_body**](../../paths/request_body_post_invalid_string_value_for_default_request_body/post.md) | +[**post_invalid_string_value_for_default_response_body_for_content_types**](../../paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) | +[**post_ipv4_format_request_body**](../../paths/request_body_post_ipv4_format_request_body/post.md) | +[**post_ipv4_format_response_body_for_content_types**](../../paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) | +[**post_ipv6_format_request_body**](../../paths/request_body_post_ipv6_format_request_body/post.md) | +[**post_ipv6_format_response_body_for_content_types**](../../paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) | +[**post_json_pointer_format_request_body**](../../paths/request_body_post_json_pointer_format_request_body/post.md) | +[**post_json_pointer_format_response_body_for_content_types**](../../paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) | +[**post_maximum_validation_request_body**](../../paths/request_body_post_maximum_validation_request_body/post.md) | +[**post_maximum_validation_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) | +[**post_maximum_validation_with_unsigned_integer_request_body**](../../paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md) | +[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) | +[**post_maxitems_validation_request_body**](../../paths/request_body_post_maxitems_validation_request_body/post.md) | +[**post_maxitems_validation_response_body_for_content_types**](../../paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) | +[**post_maxlength_validation_request_body**](../../paths/request_body_post_maxlength_validation_request_body/post.md) | +[**post_maxlength_validation_response_body_for_content_types**](../../paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) | +[**post_maxproperties0_means_the_object_is_empty_request_body**](../../paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md) | +[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](../../paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) | +[**post_maxproperties_validation_request_body**](../../paths/request_body_post_maxproperties_validation_request_body/post.md) | +[**post_maxproperties_validation_response_body_for_content_types**](../../paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_request_body**](../../paths/request_body_post_minimum_validation_request_body/post.md) | +[**post_minimum_validation_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_with_signed_integer_request_body**](../../paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md) | +[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) | +[**post_minitems_validation_request_body**](../../paths/request_body_post_minitems_validation_request_body/post.md) | +[**post_minitems_validation_response_body_for_content_types**](../../paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) | +[**post_minlength_validation_request_body**](../../paths/request_body_post_minlength_validation_request_body/post.md) | +[**post_minlength_validation_response_body_for_content_types**](../../paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) | +[**post_minproperties_validation_request_body**](../../paths/request_body_post_minproperties_validation_request_body/post.md) | +[**post_minproperties_validation_response_body_for_content_types**](../../paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) | +[**post_nested_allof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_anyof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_items_request_body**](../../paths/request_body_post_nested_items_request_body/post.md) | +[**post_nested_items_response_body_for_content_types**](../../paths/response_body_post_nested_items_response_body_for_content_types/post.md) | +[**post_nested_oneof_to_check_validation_semantics_request_body**](../../paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md) | +[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_not_more_complex_schema_request_body**](../../paths/request_body_post_not_more_complex_schema_request_body/post.md) | +[**post_not_more_complex_schema_response_body_for_content_types**](../../paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) | +[**post_not_request_body**](../../paths/request_body_post_not_request_body/post.md) | +[**post_not_response_body_for_content_types**](../../paths/response_body_post_not_response_body_for_content_types/post.md) | +[**post_nul_characters_in_strings_request_body**](../../paths/request_body_post_nul_characters_in_strings_request_body/post.md) | +[**post_nul_characters_in_strings_response_body_for_content_types**](../../paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) | +[**post_null_type_matches_only_the_null_object_request_body**](../../paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) | +[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](../../paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) | +[**post_number_type_matches_numbers_request_body**](../../paths/request_body_post_number_type_matches_numbers_request_body/post.md) | +[**post_number_type_matches_numbers_response_body_for_content_types**](../../paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) | +[**post_object_properties_validation_request_body**](../../paths/request_body_post_object_properties_validation_request_body/post.md) | +[**post_object_properties_validation_response_body_for_content_types**](../../paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) | +[**post_object_type_matches_objects_request_body**](../../paths/request_body_post_object_type_matches_objects_request_body/post.md) | +[**post_object_type_matches_objects_response_body_for_content_types**](../../paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) | +[**post_oneof_complex_types_request_body**](../../paths/request_body_post_oneof_complex_types_request_body/post.md) | +[**post_oneof_complex_types_response_body_for_content_types**](../../paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) | +[**post_oneof_request_body**](../../paths/request_body_post_oneof_request_body/post.md) | +[**post_oneof_response_body_for_content_types**](../../paths/response_body_post_oneof_response_body_for_content_types/post.md) | +[**post_oneof_with_base_schema_request_body**](../../paths/request_body_post_oneof_with_base_schema_request_body/post.md) | +[**post_oneof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_empty_schema_request_body**](../../paths/request_body_post_oneof_with_empty_schema_request_body/post.md) | +[**post_oneof_with_empty_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_required_request_body**](../../paths/request_body_post_oneof_with_required_request_body/post.md) | +[**post_oneof_with_required_response_body_for_content_types**](../../paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) | +[**post_pattern_is_not_anchored_request_body**](../../paths/request_body_post_pattern_is_not_anchored_request_body/post.md) | +[**post_pattern_is_not_anchored_response_body_for_content_types**](../../paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) | +[**post_pattern_validation_request_body**](../../paths/request_body_post_pattern_validation_request_body/post.md) | +[**post_pattern_validation_response_body_for_content_types**](../../paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) | +[**post_properties_with_escaped_characters_request_body**](../../paths/request_body_post_properties_with_escaped_characters_request_body/post.md) | +[**post_properties_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_property_named_ref_that_is_not_a_reference_request_body**](../../paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) | +[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](../../paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) | +[**post_ref_in_additionalproperties_request_body**](../../paths/request_body_post_ref_in_additionalproperties_request_body/post.md) | +[**post_ref_in_additionalproperties_response_body_for_content_types**](../../paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) | +[**post_ref_in_allof_request_body**](../../paths/request_body_post_ref_in_allof_request_body/post.md) | +[**post_ref_in_allof_response_body_for_content_types**](../../paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) | +[**post_ref_in_anyof_request_body**](../../paths/request_body_post_ref_in_anyof_request_body/post.md) | +[**post_ref_in_anyof_response_body_for_content_types**](../../paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) | +[**post_ref_in_items_request_body**](../../paths/request_body_post_ref_in_items_request_body/post.md) | +[**post_ref_in_items_response_body_for_content_types**](../../paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) | +[**post_ref_in_not_request_body**](../../paths/request_body_post_ref_in_not_request_body/post.md) | +[**post_ref_in_not_response_body_for_content_types**](../../paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) | +[**post_ref_in_oneof_request_body**](../../paths/request_body_post_ref_in_oneof_request_body/post.md) | +[**post_ref_in_oneof_response_body_for_content_types**](../../paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) | +[**post_ref_in_property_request_body**](../../paths/request_body_post_ref_in_property_request_body/post.md) | +[**post_ref_in_property_response_body_for_content_types**](../../paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) | +[**post_required_default_validation_request_body**](../../paths/request_body_post_required_default_validation_request_body/post.md) | +[**post_required_default_validation_response_body_for_content_types**](../../paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) | +[**post_required_validation_request_body**](../../paths/request_body_post_required_validation_request_body/post.md) | +[**post_required_validation_response_body_for_content_types**](../../paths/response_body_post_required_validation_response_body_for_content_types/post.md) | +[**post_required_with_empty_array_request_body**](../../paths/request_body_post_required_with_empty_array_request_body/post.md) | +[**post_required_with_empty_array_response_body_for_content_types**](../../paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) | +[**post_required_with_escaped_characters_request_body**](../../paths/request_body_post_required_with_escaped_characters_request_body/post.md) | +[**post_required_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_simple_enum_validation_request_body**](../../paths/request_body_post_simple_enum_validation_request_body/post.md) | +[**post_simple_enum_validation_response_body_for_content_types**](../../paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) | +[**post_string_type_matches_strings_request_body**](../../paths/request_body_post_string_type_matches_strings_request_body/post.md) | +[**post_string_type_matches_strings_response_body_for_content_types**](../../paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body**](../../paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](../../paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) | +[**post_uniqueitems_false_validation_request_body**](../../paths/request_body_post_uniqueitems_false_validation_request_body/post.md) | +[**post_uniqueitems_false_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) | +[**post_uniqueitems_validation_request_body**](../../paths/request_body_post_uniqueitems_validation_request_body/post.md) | +[**post_uniqueitems_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) | +[**post_uri_format_request_body**](../../paths/request_body_post_uri_format_request_body/post.md) | +[**post_uri_format_response_body_for_content_types**](../../paths/response_body_post_uri_format_response_body_for_content_types/post.md) | +[**post_uri_reference_format_request_body**](../../paths/request_body_post_uri_reference_format_request_body/post.md) | +[**post_uri_reference_format_response_body_for_content_types**](../../paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) | +[**post_uri_template_format_request_body**](../../paths/request_body_post_uri_template_format_request_body/post.md) | +[**post_uri_template_format_response_body_for_content_types**](../../paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md deleted file mode 100644 index 00b4f0f1042..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidate( - foo=None, - bar=None, - ) - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_allows_a_schema_which_should_validate_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md deleted file mode 100644 index 0ca380978d5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md deleted file mode 100644 index ef291283aa2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_are_allowed_by_default.AdditionalpropertiesAreAllowedByDefault(None) - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_are_allowed_by_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md deleted file mode 100644 index 51889d1c497..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_are_allowed_by_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md deleted file mode 100644 index 10a8d790c72..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_can_exist_by_itself.AdditionalpropertiesCanExistByItself( - key=True, - ) - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_can_exist_by_itself_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md deleted file mode 100644 index b580f7eb2ab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_can_exist_by_itself_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md deleted file mode 100644 index ad005af6f4b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = additionalproperties_should_not_look_in_applicators.AdditionalpropertiesShouldNotLookInApplicators(None) - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_should_not_look_in_applicators_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md deleted file mode 100644 index 0a733b0686d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_request_body.md deleted file mode 100644 index aaebfad784e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofCombinedWithAnyofOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_combined_with_anyof_oneof.AllofCombinedWithAnyofOneof(None) - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_combined_with_anyof_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md deleted file mode 100644 index 412d14cd4f1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_combined_with_anyof_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_request_body.md deleted file mode 100644 index 0400fc4ce3e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof.Allof(None) - try: - api_response = api_instance.post_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_response_body_for_content_types.md deleted file mode 100644 index 27848e27e26..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_request_body.md deleted file mode 100644 index 176b94e21e2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_simple_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofSimpleTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_simple_types.AllofSimpleTypes(None) - try: - api_response = api_instance.post_allof_simple_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_simple_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_response_body_for_content_types.md deleted file mode 100644 index 39be2650d7e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_simple_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_simple_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofSimpleTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_simple_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_simple_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_request_body.md deleted file mode 100644 index e3f97d7f692..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_base_schema.AllofWithBaseSchema({}) - try: - api_response = api_instance.post_allof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 593f91d457c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_request_body.md deleted file mode 100644 index 4fd8cde1db9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_one_empty_schema.AllofWithOneEmptySchema(None) - try: - api_response = api_instance.post_allof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index ded35d298fc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_request_body.md deleted file mode 100644 index d848c079715..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheFirstEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_first_empty_schema.AllofWithTheFirstEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_the_first_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md deleted file mode 100644 index a2dc7ea1972..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_the_first_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_request_body.md deleted file mode 100644 index c8d7fed6b1a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTheLastEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_the_last_empty_schema.AllofWithTheLastEmptySchema(None) - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_the_last_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 11362f91caf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_the_last_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_request_body.md deleted file mode 100644 index b7d3979974d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_allof_with_two_empty_schemas_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAllofWithTwoEmptySchemasRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = allof_with_two_empty_schemas.AllofWithTwoEmptySchemas(None) - try: - api_response = api_instance.post_allof_with_two_empty_schemas_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_two_empty_schemas_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md deleted file mode 100644 index 06bdf7dabc8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_two_empty_schemas_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_two_empty_schemas_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_allof_with_two_empty_schemas_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_request_body.md deleted file mode 100644 index cda8b3edd2b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_complex_types.AnyofComplexTypes(None) - try: - api_response = api_instance.post_anyof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 20b76269c38..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_request_body.md deleted file mode 100644 index e3f7b6f432f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof.Anyof(None) - try: - api_response = api_instance.post_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_response_body_for_content_types.md deleted file mode 100644 index a0e92c435e3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_request_body.md deleted file mode 100644 index 08a61e017c4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_base_schema.AnyofWithBaseSchema("string_example") - try: - api_response = api_instance.post_anyof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index c0330d8582c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_request_body.md deleted file mode 100644 index caaf28bf655..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_anyof_with_one_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postAnyofWithOneEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = anyof_with_one_empty_schema.AnyofWithOneEmptySchema(None) - try: - api_response = api_instance.post_anyof_with_one_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_with_one_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 862390e7dd3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_anyof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_request_body.md deleted file mode 100644 index bd0a73a2cdf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_array_type_matches_arrays_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postArrayTypeMatchesArraysRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = array_type_matches_arrays.ArrayTypeMatchesArrays([ - None - ]) - try: - api_response = api_instance.post_array_type_matches_arrays_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_array_type_matches_arrays_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md deleted file mode 100644 index d5a60a894d0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_array_type_matches_arrays_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_array_type_matches_arrays_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_array_type_matches_arrays_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_array_type_matches_arrays_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_request_body.md deleted file mode 100644 index 53a6ee73e0e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_boolean_type_matches_booleans_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBooleanTypeMatchesBooleansRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = boolean_type_matches_booleans.BooleanTypeMatchesBooleans(True) - try: - api_response = api_instance.post_boolean_type_matches_booleans_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_boolean_type_matches_booleans_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md deleted file mode 100644 index 5cfd08ee750..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_boolean_type_matches_booleans_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_boolean_type_matches_booleans_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_boolean_type_matches_booleans_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_boolean_type_matches_booleans_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_request_body.md deleted file mode 100644 index 9f70b5a3e3b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_int_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByIntRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = by_int.ByInt(None) - try: - api_response = api_instance.post_by_int_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_int_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_response_body_for_content_types.md deleted file mode 100644 index 9809b99e170..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_int_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_int_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByIntResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_int_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_int_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_request_body.md deleted file mode 100644 index 8da170cedf9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postByNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = by_number.ByNumber(None) - try: - api_response = api_instance.post_by_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_response_body_for_content_types.md deleted file mode 100644 index cc8d452643e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_request_body.md deleted file mode 100644 index 25350bf462b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_by_small_number_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBySmallNumberRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = by_small_number.BySmallNumber(None) - try: - api_response = api_instance.post_by_small_number_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_small_number_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_response_body_for_content_types.md deleted file mode 100644 index 810e60bb69b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_by_small_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_small_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBySmallNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_small_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_by_small_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_request_body.md deleted file mode 100644 index 02a27014955..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_date_time_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postDateTimeFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = date_time_format.DateTimeFormat(None) - try: - api_response = api_instance.post_date_time_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_date_time_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_response_body_for_content_types.md deleted file mode 100644 index 677b0b5d97b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_date_time_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_date_time_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postDateTimeFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_date_time_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_date_time_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_request_body.md deleted file mode 100644 index ff69bf6c12f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_email_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEmailFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = email_format.EmailFormat(None) - try: - api_response = api_instance.post_email_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_email_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_response_body_for_content_types.md deleted file mode 100644 index b285a74ccb3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_email_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_email_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEmailFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_email_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_email_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_request_body.md deleted file mode 100644 index 15c0757bf34..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with0_does_not_match_false_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith0DoesNotMatchFalseRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with0_does_not_match_false.EnumWith0DoesNotMatchFalse(0) - try: - api_response = api_instance.post_enum_with0_does_not_match_false_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with0_does_not_match_false_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md deleted file mode 100644 index e80d0935b5f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with0_does_not_match_false_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with0_does_not_match_false_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with0_does_not_match_false_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_request_body.md deleted file mode 100644 index af7fef2fbe6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with1_does_not_match_true_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWith1DoesNotMatchTrueRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with1_does_not_match_true.EnumWith1DoesNotMatchTrue(1) - try: - api_response = api_instance.post_enum_with1_does_not_match_true_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with1_does_not_match_true_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md deleted file mode 100644 index 9546a2603ad..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with1_does_not_match_true_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with1_does_not_match_true_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with1_does_not_match_true_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_request_body.md deleted file mode 100644 index b424bbfe6b2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_escaped_characters.EnumWithEscapedCharacters("foo\nbar") - try: - api_response = api_instance.post_enum_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 60a9363ed0e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_request_body.md deleted file mode 100644 index 1b901b7e07b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_false_does_not_match0_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithFalseDoesNotMatch0RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_false_does_not_match0.EnumWithFalseDoesNotMatch0(False) - try: - api_response = api_instance.post_enum_with_false_does_not_match0_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_false_does_not_match0_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md deleted file mode 100644 index bd8f54eb4c6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_false_does_not_match0_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_false_does_not_match0_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_false_does_not_match0_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_request_body.md deleted file mode 100644 index 22faa50efbb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_enum_with_true_does_not_match1_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumWithTrueDoesNotMatch1RequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enum_with_true_does_not_match1.EnumWithTrueDoesNotMatch1(True) - try: - api_response = api_instance.post_enum_with_true_does_not_match1_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_true_does_not_match1_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md deleted file mode 100644 index 6ce856d4caf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_true_does_not_match1_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_true_does_not_match1_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enum_with_true_does_not_match1_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_request_body.md deleted file mode 100644 index b3a1f56a36e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_request_body.md +++ /dev/null @@ -1,101 +0,0 @@ - -# **post_enums_in_properties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postEnumsInPropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = enums_in_properties.EnumsInProperties( - foo="foo", - bar="bar", - ) - try: - api_response = api_instance.post_enums_in_properties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enums_in_properties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_response_body_for_content_types.md deleted file mode 100644 index a3d5754ad78..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_enums_in_properties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enums_in_properties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumsInPropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enums_in_properties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_enums_in_properties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_request_body.md deleted file mode 100644 index 24f8b98af78..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_forbidden_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postForbiddenPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = forbidden_property.ForbiddenProperty(None) - try: - api_response = api_instance.post_forbidden_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_forbidden_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_response_body_for_content_types.md deleted file mode 100644 index cb54de309b6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_forbidden_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_forbidden_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postForbiddenPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_forbidden_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_forbidden_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_request_body.md deleted file mode 100644 index 1705bc90a05..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_hostname_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postHostnameFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = hostname_format.HostnameFormat(None) - try: - api_response = api_instance.post_hostname_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_hostname_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_response_body_for_content_types.md deleted file mode 100644 index e77def936ec..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_hostname_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_hostname_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postHostnameFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_hostname_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_hostname_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_request_body.md deleted file mode 100644 index 47bac77aba9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_integer_type_matches_integers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIntegerTypeMatchesIntegersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = integer_type_matches_integers.IntegerTypeMatchesIntegers(1) - try: - api_response = api_instance.post_integer_type_matches_integers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_integer_type_matches_integers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md deleted file mode 100644 index efe5af4c4ea..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_integer_type_matches_integers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_integer_type_matches_integers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_integer_type_matches_integers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_integer_type_matches_integers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md deleted file mode 100644 index ce26747d9c6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_instance_should_not_raise_error_when_float_division_inf.InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf(1) - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md deleted file mode 100644 index 1b6abee0c90..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_request_body.md deleted file mode 100644 index cb981332634..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_invalid_string_value_for_default_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postInvalidStringValueForDefaultRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = invalid_string_value_for_default.InvalidStringValueForDefault(None) - try: - api_response = api_instance.post_invalid_string_value_for_default_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_invalid_string_value_for_default_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md deleted file mode 100644 index 5c3b36145f4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_invalid_string_value_for_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_string_value_for_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_string_value_for_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_invalid_string_value_for_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_request_body.md deleted file mode 100644 index 296f07e8f49..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv4_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv4FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv4_format.Ipv4Format(None) - try: - api_response = api_instance.post_ipv4_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ipv4_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_response_body_for_content_types.md deleted file mode 100644 index f85cd9e1e5c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv4_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv4_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv4FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv4_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ipv4_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_request_body.md deleted file mode 100644 index ea665cb8d89..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ipv6_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIpv6FormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ipv6_format.Ipv6Format(None) - try: - api_response = api_instance.post_ipv6_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ipv6_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_response_body_for_content_types.md deleted file mode 100644 index 90531506d8c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ipv6_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv6_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv6FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv6_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ipv6_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_request_body.md deleted file mode 100644 index dce32f1bf09..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_json_pointer_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postJsonPointerFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = json_pointer_format.JsonPointerFormat(None) - try: - api_response = api_instance.post_json_pointer_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_json_pointer_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_response_body_for_content_types.md deleted file mode 100644 index 8515df35070..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_json_pointer_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_json_pointer_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postJsonPointerFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_json_pointer_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_json_pointer_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_request_body.md deleted file mode 100644 index ca1eb298034..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation.MaximumValidation(None) - try: - api_response = api_instance.post_maximum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maximum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_response_body_for_content_types.md deleted file mode 100644 index 804b9b753e3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maximum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md deleted file mode 100644 index a96f0c2e552..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maximum_validation_with_unsigned_integer.MaximumValidationWithUnsignedInteger(None) - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maximum_validation_with_unsigned_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md deleted file mode 100644 index 5d3a38297b3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maximum_validation_with_unsigned_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_request_body.md deleted file mode 100644 index 1613973c7d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maxitems_validation.MaxitemsValidation(None) - try: - api_response = api_instance.post_maxitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_response_body_for_content_types.md deleted file mode 100644 index 89037eb4010..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_request_body.md deleted file mode 100644 index 02a163e5a10..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maxlength_validation.MaxlengthValidation(None) - try: - api_response = api_instance.post_maxlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_response_body_for_content_types.md deleted file mode 100644 index aa81d016224..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md deleted file mode 100644 index 49982ee360e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties0_means_the_object_is_empty.Maxproperties0MeansTheObjectIsEmpty(None) - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxproperties0_means_the_object_is_empty_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md deleted file mode 100644 index 161b9a9ec4f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxproperties0_means_the_object_is_empty_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_request_body.md deleted file mode 100644 index 4cd22776b8d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_maxproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMaxpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = maxproperties_validation.MaxpropertiesValidation(None) - try: - api_response = api_instance.post_maxproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_response_body_for_content_types.md deleted file mode 100644 index ee356ac7e5a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_maxproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_maxproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_request_body.md deleted file mode 100644 index 1267379bb96..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation.MinimumValidation(None) - try: - api_response = api_instance.post_minimum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minimum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_response_body_for_content_types.md deleted file mode 100644 index 04eb351fca9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minimum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_request_body.md deleted file mode 100644 index b4aa723ac82..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinimumValidationWithSignedIntegerRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = minimum_validation_with_signed_integer.MinimumValidationWithSignedInteger(None) - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minimum_validation_with_signed_integer_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md deleted file mode 100644 index 8d29af8c943..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minimum_validation_with_signed_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_request_body.md deleted file mode 100644 index 0ee6e7341d3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = minitems_validation.MinitemsValidation(None) - try: - api_response = api_instance.post_minitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_response_body_for_content_types.md deleted file mode 100644 index 770331142fb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_request_body.md deleted file mode 100644 index 18b5097dbd1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minlength_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinlengthValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = minlength_validation.MinlengthValidation(None) - try: - api_response = api_instance.post_minlength_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minlength_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_response_body_for_content_types.md deleted file mode 100644 index 0864a171e72..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_request_body.md deleted file mode 100644 index 340134e993e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_minproperties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postMinpropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = minproperties_validation.MinpropertiesValidation(None) - try: - api_response = api_instance.post_minproperties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minproperties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 038ed03e4fe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_minproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_minproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 615637fb3b4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_allof_to_check_validation_semantics.NestedAllofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_allof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 65837fc9e9c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_allof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md deleted file mode 100644 index 505674e3488..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_anyof_to_check_validation_semantics.NestedAnyofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_anyof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 2a7a82df3e5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_anyof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_request_body.md deleted file mode 100644 index 73b86ab5a29..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_request_body.md +++ /dev/null @@ -1,106 +0,0 @@ - -# **post_nested_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_items.NestedItems([ - [ - [ - [ - 3.14 - ] - ] - ] - ]) - try: - api_response = api_instance.post_nested_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_response_body_for_content_types.md deleted file mode 100644 index ed3b2d255c6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md deleted file mode 100644 index b03c355e4d9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = nested_oneof_to_check_validation_semantics.NestedOneofToCheckValidationSemantics(None) - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_oneof_to_check_validation_semantics_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 6f9bbb2222e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nested_oneof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_request_body.md deleted file mode 100644 index 34db67bdb04..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_more_complex_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotMoreComplexSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = not_more_complex_schema.NotMoreComplexSchema(None) - try: - api_response = api_instance.post_not_more_complex_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_not_more_complex_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_response_body_for_content_types.md deleted file mode 100644 index 6c951fe2d51..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_more_complex_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_more_complex_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_more_complex_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_not_more_complex_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_request_body.md deleted file mode 100644 index 017ba579a79..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = _not._Not(None) - try: - api_response = api_instance.post_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_response_body_for_content_types.md deleted file mode 100644 index 0d321436410..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_request_body.md deleted file mode 100644 index a3c5b18e9b3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_nul_characters_in_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNulCharactersInStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = nul_characters_in_strings.NulCharactersInStrings("hello\x00there") - try: - api_response = api_instance.post_nul_characters_in_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nul_characters_in_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md deleted file mode 100644 index 8dbc0112e3d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_nul_characters_in_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nul_characters_in_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNulCharactersInStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nul_characters_in_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_nul_characters_in_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_request_body.md deleted file mode 100644 index ecc47555fab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), None] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = null_type_matches_only_the_null_object.NullTypeMatchesOnlyTheNullObject(None) - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_null_type_matches_only_the_null_object_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md deleted file mode 100644 index 862c5cec785..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_null_type_matches_only_the_null_object_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_request_body.md deleted file mode 100644 index 7893413503c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_number_type_matches_numbers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNumberTypeMatchesNumbersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = number_type_matches_numbers.NumberTypeMatchesNumbers(3.14) - try: - api_response = api_instance.post_number_type_matches_numbers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_number_type_matches_numbers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md deleted file mode 100644 index 87fdbe4e55b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_number_type_matches_numbers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_number_type_matches_numbers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_number_type_matches_numbers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_number_type_matches_numbers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_request_body.md deleted file mode 100644 index 6cf54acc64e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_properties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectPropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = object_properties_validation.ObjectPropertiesValidation(None) - try: - api_response = api_instance.post_object_properties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_object_properties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_response_body_for_content_types.md deleted file mode 100644 index e8600bb9c35..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_properties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_properties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_properties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_object_properties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_request_body.md deleted file mode 100644 index e9ddd6e33d0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_type_matches_objects_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectTypeMatchesObjectsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = object_type_matches_objects.ObjectTypeMatchesObjects() - try: - api_response = api_instance.post_object_type_matches_objects_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_object_type_matches_objects_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_response_body_for_content_types.md deleted file mode 100644 index 407cea7a5f7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_object_type_matches_objects_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_type_matches_objects_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_type_matches_objects_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_object_type_matches_objects_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_request_body.md deleted file mode 100644 index e77fd12b993..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_complex_types_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofComplexTypesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_complex_types.OneofComplexTypes(None) - try: - api_response = api_instance.post_oneof_complex_types_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_complex_types_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 834b725a7d9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_request_body.md deleted file mode 100644 index 04f871e3b6c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof.Oneof(None) - try: - api_response = api_instance.post_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_response_body_for_content_types.md deleted file mode 100644 index 38aa2106553..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_request_body.md deleted file mode 100644 index 6478ab409fa..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_base_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithBaseSchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_base_schema.OneofWithBaseSchema("string_example") - try: - api_response = api_instance.post_oneof_with_base_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_base_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 1826ff8f0a3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_request_body.md deleted file mode 100644 index 4e3fac32881..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_empty_schema_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithEmptySchemaRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_empty_schema.OneofWithEmptySchema(None) - try: - api_response = api_instance.post_oneof_with_empty_schema_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_empty_schema_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 85edfb4f12d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_request_body.md deleted file mode 100644 index 429c00121b8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_oneof_with_required_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postOneofWithRequiredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = oneof_with_required.OneofWithRequired() - try: - api_response = api_instance.post_oneof_with_required_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_required_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_response_body_for_content_types.md deleted file mode 100644 index fd5ff111702..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_oneof_with_required_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_required_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithRequiredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_required_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_oneof_with_required_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_request_body.md deleted file mode 100644 index 4fae69507c3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_is_not_anchored_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternIsNotAnchoredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_is_not_anchored.PatternIsNotAnchored(None) - try: - api_response = api_instance.post_pattern_is_not_anchored_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_pattern_is_not_anchored_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md deleted file mode 100644 index bcb67a92cff..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_is_not_anchored_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_is_not_anchored_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_is_not_anchored_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_pattern_is_not_anchored_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_request_body.md deleted file mode 100644 index de80037775c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_validation.PatternValidation(None) - try: - api_response = api_instance.post_pattern_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_pattern_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_response_body_for_content_types.md deleted file mode 100644 index b1aa677fd6e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_pattern_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_pattern_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_request_body.md deleted file mode 100644 index 1733c1329a8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_properties_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertiesWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = properties_with_escaped_characters.PropertiesWithEscapedCharacters(None) - try: - api_response = api_instance.post_properties_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_properties_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 7031e6d529d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_properties_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_properties_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_properties_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_properties_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md deleted file mode 100644 index 509a47ea937..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_property_named_ref_that_is_not_a_reference_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md deleted file mode 100644 index 9b2708aa1b2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_property_named_ref_that_is_not_a_reference_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_request_body.md deleted file mode 100644 index d393ab5b8e2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_additionalproperties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAdditionalpropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_additionalproperties.RefInAdditionalproperties( - key=property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None), - ) - try: - api_response = api_instance.post_ref_in_additionalproperties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_additionalproperties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md deleted file mode 100644 index 259b6615deb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_additionalproperties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_additionalproperties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_additionalproperties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_additionalproperties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_request_body.md deleted file mode 100644 index 5e024e1e681..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_allof.RefInAllof(None) - try: - api_response = api_instance.post_ref_in_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_response_body_for_content_types.md deleted file mode 100644 index 75f26edf14a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_request_body.md deleted file mode 100644 index 6e19433b8fe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_anyof.RefInAnyof(None) - try: - api_response = api_instance.post_ref_in_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_response_body_for_content_types.md deleted file mode 100644 index fda89b6f7f6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_request_body.md deleted file mode 100644 index 80fe05ad061..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_items.RefInItems([ - property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - ]) - try: - api_response = api_instance.post_ref_in_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_response_body_for_content_types.md deleted file mode 100644 index 4316dfb8866..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_request_body.md deleted file mode 100644 index cc07de8134d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_not.RefInNot(None) - try: - api_response = api_instance.post_ref_in_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_response_body_for_content_types.md deleted file mode 100644 index 9c620d78c99..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_request_body.md deleted file mode 100644 index da7f0799def..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_oneof.RefInOneof(None) - try: - api_response = api_instance.post_ref_in_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_response_body_for_content_types.md deleted file mode 100644 index d15301a3100..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_request_body.md deleted file mode 100644 index da0c4e30a94..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_property.RefInProperty(None) - try: - api_response = api_instance.post_ref_in_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_response_body_for_content_types.md deleted file mode 100644 index e836da08129..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_ref_in_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_ref_in_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_request_body.md deleted file mode 100644 index 7e26773e397..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_default_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredDefaultValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = required_default_validation.RequiredDefaultValidation(None) - try: - api_response = api_instance.post_required_default_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_default_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_response_body_for_content_types.md deleted file mode 100644 index 15e080b34ff..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_default_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_default_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_default_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_default_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_request_body.md deleted file mode 100644 index 8b11716d0b8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = required_validation.RequiredValidation(None) - try: - api_response = api_instance.post_required_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_response_body_for_content_types.md deleted file mode 100644 index 57a39870957..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_request_body.md deleted file mode 100644 index 142387e68a7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_empty_array_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEmptyArrayRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_empty_array.RequiredWithEmptyArray(None) - try: - api_response = api_instance.post_required_with_empty_array_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_with_empty_array_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_response_body_for_content_types.md deleted file mode 100644 index 80740b3777f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_empty_array_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_empty_array_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_empty_array_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_with_empty_array_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_request_body.md deleted file mode 100644 index 399bd92f349..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_escaped_characters.RequiredWithEscapedCharacters(None) - try: - api_response = api_instance.post_required_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 3c5fd5a87f0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_required_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_required_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_request_body.md deleted file mode 100644 index 5d2c9a18a25..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_simple_enum_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postSimpleEnumValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = simple_enum_validation.SimpleEnumValidation(1) - try: - api_response = api_instance.post_simple_enum_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_simple_enum_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_response_body_for_content_types.md deleted file mode 100644 index 3219534e57a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_simple_enum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_simple_enum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postSimpleEnumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_simple_enum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_simple_enum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_request_body.md deleted file mode 100644 index 0be44659900..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_string_type_matches_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postStringTypeMatchesStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = string_type_matches_strings.StringTypeMatchesStrings("string_example") - try: - api_response = api_instance.post_string_type_matches_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_string_type_matches_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_response_body_for_content_types.md deleted file mode 100644 index 13805b7fdda..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_string_type_matches_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_string_type_matches_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_string_type_matches_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_string_type_matches_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md deleted file mode 100644 index dac792855f5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = the_default_keyword_does_not_do_anything_if_the_property_is_missing.TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing( - alpha=5, - ) - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md deleted file mode 100644 index 99da0c1f106..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_request_body.md deleted file mode 100644 index fe6fa265772..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_false_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsFalseValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_false_validation.UniqueitemsFalseValidation(None) - try: - api_response = api_instance.post_uniqueitems_false_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uniqueitems_false_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md deleted file mode 100644 index d6847b9cbf8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_false_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_false_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_false_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uniqueitems_false_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_request_body.md deleted file mode 100644 index 8787f5f6350..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_validation.UniqueitemsValidation(None) - try: - api_response = api_instance.post_uniqueitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uniqueitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_response_body_for_content_types.md deleted file mode 100644 index 44bdd17478d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uniqueitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uniqueitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_request_body.md deleted file mode 100644 index c0b54eb70a0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_format.UriFormat(None) - try: - api_response = api_instance.post_uri_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_response_body_for_content_types.md deleted file mode 100644 index d95d74a6059..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_request_body.md deleted file mode 100644 index 048145b840d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_reference_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriReferenceFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_reference_format.UriReferenceFormat(None) - try: - api_response = api_instance.post_uri_reference_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_reference_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_response_body_for_content_types.md deleted file mode 100644 index 0ee5df27bcf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_reference_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_reference_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriReferenceFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_reference_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_reference_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_request_body.md deleted file mode 100644 index ec3c8944f51..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uri_template_format_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUriTemplateFormatRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example passing only required values which don't have defaults set - body = uri_template_format.UriTemplateFormat(None) - try: - api_response = api_instance.post_uri_template_format_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_template_format_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_response_body_for_content_types.md deleted file mode 100644 index f4b23ef85c5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/path_post_api/post_uri_template_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_template_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriTemplateFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import path_post_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = path_post_api.PathPostApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_template_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PathPostApi->post_uri_template_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../path_post_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api.md index 1002e411013..e36a5db710f 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_pattern_is_not_anchored_request_body**](pattern_api/post_pattern_is_not_anchored_request_body.md) | -[**post_pattern_is_not_anchored_response_body_for_content_types**](pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md) | -[**post_pattern_validation_request_body**](pattern_api/post_pattern_validation_request_body.md) | -[**post_pattern_validation_response_body_for_content_types**](pattern_api/post_pattern_validation_response_body_for_content_types.md) | +[**post_pattern_is_not_anchored_request_body**](../../paths/request_body_post_pattern_is_not_anchored_request_body/post.md) | +[**post_pattern_is_not_anchored_response_body_for_content_types**](../../paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) | +[**post_pattern_validation_request_body**](../../paths/request_body_post_pattern_validation_request_body/post.md) | +[**post_pattern_validation_response_body_for_content_types**](../../paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_request_body.md deleted file mode 100644 index 8395d817156..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_is_not_anchored_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternIsNotAnchoredRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import pattern_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pattern_api.PatternApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_is_not_anchored.PatternIsNotAnchored(None) - try: - api_response = api_instance.post_pattern_is_not_anchored_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PatternApi->post_pattern_is_not_anchored_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pattern_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md deleted file mode 100644 index be6e2a0bf10..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_is_not_anchored_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_is_not_anchored_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import pattern_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pattern_api.PatternApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_is_not_anchored_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PatternApi->post_pattern_is_not_anchored_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pattern_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_request_body.md deleted file mode 100644 index fcca2ea324c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_pattern_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPatternValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import pattern_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pattern_api.PatternApi(api_client) - - # example passing only required values which don't have defaults set - body = pattern_validation.PatternValidation(None) - try: - api_response = api_instance.post_pattern_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PatternApi->post_pattern_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pattern_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_response_body_for_content_types.md deleted file mode 100644 index cda13159a2a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/pattern_api/post_pattern_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import pattern_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pattern_api.PatternApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PatternApi->post_pattern_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pattern_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api.md index 8ec7cc73a38..49bc5901215 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_object_properties_validation_request_body**](properties_api/post_object_properties_validation_request_body.md) | -[**post_object_properties_validation_response_body_for_content_types**](properties_api/post_object_properties_validation_response_body_for_content_types.md) | -[**post_properties_with_escaped_characters_request_body**](properties_api/post_properties_with_escaped_characters_request_body.md) | -[**post_properties_with_escaped_characters_response_body_for_content_types**](properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md) | +[**post_object_properties_validation_request_body**](../../paths/request_body_post_object_properties_validation_request_body/post.md) | +[**post_object_properties_validation_response_body_for_content_types**](../../paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) | +[**post_properties_with_escaped_characters_request_body**](../../paths/request_body_post_properties_with_escaped_characters_request_body/post.md) | +[**post_properties_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_request_body.md deleted file mode 100644 index b623705fe3a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_properties_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectPropertiesValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = properties_api.PropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = object_properties_validation.ObjectPropertiesValidation(None) - try: - api_response = api_instance.post_object_properties_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PropertiesApi->post_object_properties_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_response_body_for_content_types.md deleted file mode 100644 index 9aedcc1f98e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_object_properties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_properties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = properties_api.PropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_properties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PropertiesApi->post_object_properties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_request_body.md deleted file mode 100644 index 94311944066..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_properties_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertiesWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = properties_api.PropertiesApi(api_client) - - # example passing only required values which don't have defaults set - body = properties_with_escaped_characters.PropertiesWithEscapedCharacters(None) - try: - api_response = api_instance.post_properties_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PropertiesApi->post_properties_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index d998f95333f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/properties_api/post_properties_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_properties_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import properties_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = properties_api.PropertiesApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_properties_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling PropertiesApi->post_properties_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../properties_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api.md index 37b99246953..eef0c1721f6 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api.md @@ -9,21 +9,21 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_property_named_ref_that_is_not_a_reference_request_body**](ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md) | -[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) | -[**post_ref_in_additionalproperties_request_body**](ref_api/post_ref_in_additionalproperties_request_body.md) | -[**post_ref_in_additionalproperties_response_body_for_content_types**](ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md) | -[**post_ref_in_allof_request_body**](ref_api/post_ref_in_allof_request_body.md) | -[**post_ref_in_allof_response_body_for_content_types**](ref_api/post_ref_in_allof_response_body_for_content_types.md) | -[**post_ref_in_anyof_request_body**](ref_api/post_ref_in_anyof_request_body.md) | -[**post_ref_in_anyof_response_body_for_content_types**](ref_api/post_ref_in_anyof_response_body_for_content_types.md) | -[**post_ref_in_items_request_body**](ref_api/post_ref_in_items_request_body.md) | -[**post_ref_in_items_response_body_for_content_types**](ref_api/post_ref_in_items_response_body_for_content_types.md) | -[**post_ref_in_not_request_body**](ref_api/post_ref_in_not_request_body.md) | -[**post_ref_in_not_response_body_for_content_types**](ref_api/post_ref_in_not_response_body_for_content_types.md) | -[**post_ref_in_oneof_request_body**](ref_api/post_ref_in_oneof_request_body.md) | -[**post_ref_in_oneof_response_body_for_content_types**](ref_api/post_ref_in_oneof_response_body_for_content_types.md) | -[**post_ref_in_property_request_body**](ref_api/post_ref_in_property_request_body.md) | -[**post_ref_in_property_response_body_for_content_types**](ref_api/post_ref_in_property_response_body_for_content_types.md) | +[**post_property_named_ref_that_is_not_a_reference_request_body**](../../paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md) | +[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](../../paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) | +[**post_ref_in_additionalproperties_request_body**](../../paths/request_body_post_ref_in_additionalproperties_request_body/post.md) | +[**post_ref_in_additionalproperties_response_body_for_content_types**](../../paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) | +[**post_ref_in_allof_request_body**](../../paths/request_body_post_ref_in_allof_request_body/post.md) | +[**post_ref_in_allof_response_body_for_content_types**](../../paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) | +[**post_ref_in_anyof_request_body**](../../paths/request_body_post_ref_in_anyof_request_body/post.md) | +[**post_ref_in_anyof_response_body_for_content_types**](../../paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) | +[**post_ref_in_items_request_body**](../../paths/request_body_post_ref_in_items_request_body/post.md) | +[**post_ref_in_items_response_body_for_content_types**](../../paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) | +[**post_ref_in_not_request_body**](../../paths/request_body_post_ref_in_not_request_body/post.md) | +[**post_ref_in_not_response_body_for_content_types**](../../paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) | +[**post_ref_in_oneof_request_body**](../../paths/request_body_post_ref_in_oneof_request_body/post.md) | +[**post_ref_in_oneof_response_body_for_content_types**](../../paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) | +[**post_ref_in_property_request_body**](../../paths/request_body_post_ref_in_property_request_body/post.md) | +[**post_ref_in_property_response_body_for_content_types**](../../paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md deleted file mode 100644 index d666de6b588..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_property_named_ref_that_is_not_a_reference_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md deleted file mode 100644 index 36e516fd031..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_property_named_ref_that_is_not_a_reference_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_request_body.md deleted file mode 100644 index ec63440c044..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_additionalproperties_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAdditionalpropertiesRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_additionalproperties.RefInAdditionalproperties( - key=property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None), - ) - try: - api_response = api_instance.post_ref_in_additionalproperties_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_additionalproperties_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md deleted file mode 100644 index 04097478347..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_additionalproperties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_additionalproperties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_additionalproperties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_additionalproperties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_request_body.md deleted file mode 100644 index 813dabbefb5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_allof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAllofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_allof.RefInAllof(None) - try: - api_response = api_instance.post_ref_in_allof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_allof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_response_body_for_content_types.md deleted file mode 100644 index 902ebaac910..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_request_body.md deleted file mode 100644 index 3f94d19f3e1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_anyof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInAnyofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_anyof.RefInAnyof(None) - try: - api_response = api_instance.post_ref_in_anyof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_anyof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_response_body_for_content_types.md deleted file mode 100644 index dcda82d9831..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_request_body.md deleted file mode 100644 index 62c6fd5a4a2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_ref_in_items_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInItemsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_items.RefInItems([ - property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) - ]) - try: - api_response = api_instance.post_ref_in_items_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_items_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_response_body_for_content_types.md deleted file mode 100644 index 096f7f3eb0a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_request_body.md deleted file mode 100644 index dd857f15048..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_not_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInNotRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_not.RefInNot(None) - try: - api_response = api_instance.post_ref_in_not_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_not_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_response_body_for_content_types.md deleted file mode 100644 index 9c786cc285c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_request_body.md deleted file mode 100644 index a93aa3ed8bc..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_oneof_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInOneofRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_oneof.RefInOneof(None) - try: - api_response = api_instance.post_ref_in_oneof_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_oneof_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_response_body_for_content_types.md deleted file mode 100644 index 525de9c3be6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_request_body.md deleted file mode 100644 index a1ca69fd810..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_ref_in_property_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRefInPropertyRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example passing only required values which don't have defaults set - body = ref_in_property.RefInProperty(None) - try: - api_response = api_instance.post_ref_in_property_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_property_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_response_body_for_content_types.md deleted file mode 100644 index 6cc44a5fc2f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/ref_api/post_ref_in_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import ref_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = ref_api.RefApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RefApi->post_ref_in_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../ref_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api.md index 0fc558a0220..a37631ea5ea 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api.md @@ -9,13 +9,13 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_required_default_validation_request_body**](required_api/post_required_default_validation_request_body.md) | -[**post_required_default_validation_response_body_for_content_types**](required_api/post_required_default_validation_response_body_for_content_types.md) | -[**post_required_validation_request_body**](required_api/post_required_validation_request_body.md) | -[**post_required_validation_response_body_for_content_types**](required_api/post_required_validation_response_body_for_content_types.md) | -[**post_required_with_empty_array_request_body**](required_api/post_required_with_empty_array_request_body.md) | -[**post_required_with_empty_array_response_body_for_content_types**](required_api/post_required_with_empty_array_response_body_for_content_types.md) | -[**post_required_with_escaped_characters_request_body**](required_api/post_required_with_escaped_characters_request_body.md) | -[**post_required_with_escaped_characters_response_body_for_content_types**](required_api/post_required_with_escaped_characters_response_body_for_content_types.md) | +[**post_required_default_validation_request_body**](../../paths/request_body_post_required_default_validation_request_body/post.md) | +[**post_required_default_validation_response_body_for_content_types**](../../paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) | +[**post_required_validation_request_body**](../../paths/request_body_post_required_validation_request_body/post.md) | +[**post_required_validation_response_body_for_content_types**](../../paths/response_body_post_required_validation_response_body_for_content_types/post.md) | +[**post_required_with_empty_array_request_body**](../../paths/request_body_post_required_with_empty_array_request_body/post.md) | +[**post_required_with_empty_array_response_body_for_content_types**](../../paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) | +[**post_required_with_escaped_characters_request_body**](../../paths/request_body_post_required_with_escaped_characters_request_body/post.md) | +[**post_required_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_request_body.md deleted file mode 100644 index 15f68c6e2e0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_default_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredDefaultValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example passing only required values which don't have defaults set - body = required_default_validation.RequiredDefaultValidation(None) - try: - api_response = api_instance.post_required_default_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_default_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_response_body_for_content_types.md deleted file mode 100644 index 086869ad88e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_default_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_default_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_default_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_default_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_request_body.md deleted file mode 100644 index bbc6a99069f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example passing only required values which don't have defaults set - body = required_validation.RequiredValidation(None) - try: - api_response = api_instance.post_required_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_response_body_for_content_types.md deleted file mode 100644 index 3cf2f31b4b9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_request_body.md deleted file mode 100644 index d7effb081e8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_empty_array_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEmptyArrayRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_empty_array.RequiredWithEmptyArray(None) - try: - api_response = api_instance.post_required_with_empty_array_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_with_empty_array_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_response_body_for_content_types.md deleted file mode 100644 index 8e6184f5ef9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_empty_array_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_empty_array_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_empty_array_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_with_empty_array_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_request_body.md deleted file mode 100644 index fa293ca8ac5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_required_with_escaped_characters_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postRequiredWithEscapedCharactersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example passing only required values which don't have defaults set - body = required_with_escaped_characters.RequiredWithEscapedCharacters(None) - try: - api_response = api_instance.post_required_with_escaped_characters_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_with_escaped_characters_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index d75fa8de6b1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/required_api/post_required_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import required_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = required_api.RequiredApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling RequiredApi->post_required_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../required_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api.md index f4db778f848..31eea7f8cea 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api.md @@ -9,92 +9,92 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md) | -[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md) | -[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md) | -[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md) | -[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md) | -[**post_allof_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_response_body_for_content_types.md) | -[**post_allof_simple_types_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md) | -[**post_allof_with_base_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md) | -[**post_allof_with_one_empty_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md) | -[**post_allof_with_two_empty_schemas_response_body_for_content_types**](response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md) | -[**post_anyof_complex_types_response_body_for_content_types**](response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md) | -[**post_anyof_response_body_for_content_types**](response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md) | -[**post_anyof_with_base_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md) | -[**post_anyof_with_one_empty_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md) | -[**post_array_type_matches_arrays_response_body_for_content_types**](response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md) | -[**post_boolean_type_matches_booleans_response_body_for_content_types**](response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) | -[**post_by_int_response_body_for_content_types**](response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md) | -[**post_by_number_response_body_for_content_types**](response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md) | -[**post_by_small_number_response_body_for_content_types**](response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md) | -[**post_date_time_format_response_body_for_content_types**](response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md) | -[**post_email_format_response_body_for_content_types**](response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md) | -[**post_enum_with0_does_not_match_false_response_body_for_content_types**](response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md) | -[**post_enum_with1_does_not_match_true_response_body_for_content_types**](response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md) | -[**post_enum_with_escaped_characters_response_body_for_content_types**](response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md) | -[**post_enum_with_false_does_not_match0_response_body_for_content_types**](response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md) | -[**post_enum_with_true_does_not_match1_response_body_for_content_types**](response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md) | -[**post_enums_in_properties_response_body_for_content_types**](response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md) | -[**post_forbidden_property_response_body_for_content_types**](response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md) | -[**post_hostname_format_response_body_for_content_types**](response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md) | -[**post_integer_type_matches_integers_response_body_for_content_types**](response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md) | -[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md) | -[**post_invalid_string_value_for_default_response_body_for_content_types**](response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md) | -[**post_ipv4_format_response_body_for_content_types**](response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md) | -[**post_ipv6_format_response_body_for_content_types**](response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md) | -[**post_json_pointer_format_response_body_for_content_types**](response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md) | -[**post_maximum_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md) | -[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md) | -[**post_maxitems_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md) | -[**post_maxlength_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md) | -[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md) | -[**post_maxproperties_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md) | -[**post_minimum_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md) | -[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md) | -[**post_minitems_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md) | -[**post_minlength_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md) | -[**post_minproperties_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md) | -[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_nested_items_response_body_for_content_types**](response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md) | -[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md) | -[**post_not_more_complex_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md) | -[**post_not_response_body_for_content_types**](response_content_content_type_schema_api/post_not_response_body_for_content_types.md) | -[**post_nul_characters_in_strings_response_body_for_content_types**](response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md) | -[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) | -[**post_number_type_matches_numbers_response_body_for_content_types**](response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md) | -[**post_object_properties_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md) | -[**post_object_type_matches_objects_response_body_for_content_types**](response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md) | -[**post_oneof_complex_types_response_body_for_content_types**](response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md) | -[**post_oneof_response_body_for_content_types**](response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md) | -[**post_oneof_with_base_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md) | -[**post_oneof_with_empty_schema_response_body_for_content_types**](response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md) | -[**post_oneof_with_required_response_body_for_content_types**](response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md) | -[**post_pattern_is_not_anchored_response_body_for_content_types**](response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md) | -[**post_pattern_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md) | -[**post_properties_with_escaped_characters_response_body_for_content_types**](response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md) | -[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md) | -[**post_ref_in_additionalproperties_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md) | -[**post_ref_in_allof_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md) | -[**post_ref_in_anyof_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md) | -[**post_ref_in_items_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md) | -[**post_ref_in_not_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md) | -[**post_ref_in_oneof_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md) | -[**post_ref_in_property_response_body_for_content_types**](response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md) | -[**post_required_default_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md) | -[**post_required_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md) | -[**post_required_with_empty_array_response_body_for_content_types**](response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md) | -[**post_required_with_escaped_characters_response_body_for_content_types**](response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md) | -[**post_simple_enum_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md) | -[**post_string_type_matches_strings_response_body_for_content_types**](response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md) | -[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md) | -[**post_uniqueitems_false_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md) | -[**post_uniqueitems_validation_response_body_for_content_types**](response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md) | -[**post_uri_format_response_body_for_content_types**](response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md) | -[**post_uri_reference_format_response_body_for_content_types**](response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md) | -[**post_uri_template_format_response_body_for_content_types**](response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md) | +[**post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md) | +[**post_additionalproperties_are_allowed_by_default_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md) | +[**post_additionalproperties_can_exist_by_itself_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md) | +[**post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types**](../../paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md) | +[**post_allof_combined_with_anyof_oneof_response_body_for_content_types**](../../paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md) | +[**post_allof_response_body_for_content_types**](../../paths/response_body_post_allof_response_body_for_content_types/post.md) | +[**post_allof_simple_types_response_body_for_content_types**](../../paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md) | +[**post_allof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md) | +[**post_allof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_first_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_the_last_empty_schema_response_body_for_content_types**](../../paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md) | +[**post_allof_with_two_empty_schemas_response_body_for_content_types**](../../paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md) | +[**post_anyof_complex_types_response_body_for_content_types**](../../paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md) | +[**post_anyof_response_body_for_content_types**](../../paths/response_body_post_anyof_response_body_for_content_types/post.md) | +[**post_anyof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md) | +[**post_anyof_with_one_empty_schema_response_body_for_content_types**](../../paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md) | +[**post_array_type_matches_arrays_response_body_for_content_types**](../../paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) | +[**post_boolean_type_matches_booleans_response_body_for_content_types**](../../paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) | +[**post_by_int_response_body_for_content_types**](../../paths/response_body_post_by_int_response_body_for_content_types/post.md) | +[**post_by_number_response_body_for_content_types**](../../paths/response_body_post_by_number_response_body_for_content_types/post.md) | +[**post_by_small_number_response_body_for_content_types**](../../paths/response_body_post_by_small_number_response_body_for_content_types/post.md) | +[**post_date_time_format_response_body_for_content_types**](../../paths/response_body_post_date_time_format_response_body_for_content_types/post.md) | +[**post_email_format_response_body_for_content_types**](../../paths/response_body_post_email_format_response_body_for_content_types/post.md) | +[**post_enum_with0_does_not_match_false_response_body_for_content_types**](../../paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md) | +[**post_enum_with1_does_not_match_true_response_body_for_content_types**](../../paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md) | +[**post_enum_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_enum_with_false_does_not_match0_response_body_for_content_types**](../../paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md) | +[**post_enum_with_true_does_not_match1_response_body_for_content_types**](../../paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md) | +[**post_enums_in_properties_response_body_for_content_types**](../../paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md) | +[**post_forbidden_property_response_body_for_content_types**](../../paths/response_body_post_forbidden_property_response_body_for_content_types/post.md) | +[**post_hostname_format_response_body_for_content_types**](../../paths/response_body_post_hostname_format_response_body_for_content_types/post.md) | +[**post_integer_type_matches_integers_response_body_for_content_types**](../../paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) | +[**post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types**](../../paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md) | +[**post_invalid_string_value_for_default_response_body_for_content_types**](../../paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md) | +[**post_ipv4_format_response_body_for_content_types**](../../paths/response_body_post_ipv4_format_response_body_for_content_types/post.md) | +[**post_ipv6_format_response_body_for_content_types**](../../paths/response_body_post_ipv6_format_response_body_for_content_types/post.md) | +[**post_json_pointer_format_response_body_for_content_types**](../../paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md) | +[**post_maximum_validation_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_response_body_for_content_types/post.md) | +[**post_maximum_validation_with_unsigned_integer_response_body_for_content_types**](../../paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md) | +[**post_maxitems_validation_response_body_for_content_types**](../../paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md) | +[**post_maxlength_validation_response_body_for_content_types**](../../paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md) | +[**post_maxproperties0_means_the_object_is_empty_response_body_for_content_types**](../../paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md) | +[**post_maxproperties_validation_response_body_for_content_types**](../../paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_response_body_for_content_types/post.md) | +[**post_minimum_validation_with_signed_integer_response_body_for_content_types**](../../paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md) | +[**post_minitems_validation_response_body_for_content_types**](../../paths/response_body_post_minitems_validation_response_body_for_content_types/post.md) | +[**post_minlength_validation_response_body_for_content_types**](../../paths/response_body_post_minlength_validation_response_body_for_content_types/post.md) | +[**post_minproperties_validation_response_body_for_content_types**](../../paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md) | +[**post_nested_allof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_anyof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_nested_items_response_body_for_content_types**](../../paths/response_body_post_nested_items_response_body_for_content_types/post.md) | +[**post_nested_oneof_to_check_validation_semantics_response_body_for_content_types**](../../paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md) | +[**post_not_more_complex_schema_response_body_for_content_types**](../../paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md) | +[**post_not_response_body_for_content_types**](../../paths/response_body_post_not_response_body_for_content_types/post.md) | +[**post_nul_characters_in_strings_response_body_for_content_types**](../../paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md) | +[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](../../paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) | +[**post_number_type_matches_numbers_response_body_for_content_types**](../../paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) | +[**post_object_properties_validation_response_body_for_content_types**](../../paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md) | +[**post_object_type_matches_objects_response_body_for_content_types**](../../paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) | +[**post_oneof_complex_types_response_body_for_content_types**](../../paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md) | +[**post_oneof_response_body_for_content_types**](../../paths/response_body_post_oneof_response_body_for_content_types/post.md) | +[**post_oneof_with_base_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_empty_schema_response_body_for_content_types**](../../paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md) | +[**post_oneof_with_required_response_body_for_content_types**](../../paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md) | +[**post_pattern_is_not_anchored_response_body_for_content_types**](../../paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md) | +[**post_pattern_validation_response_body_for_content_types**](../../paths/response_body_post_pattern_validation_response_body_for_content_types/post.md) | +[**post_properties_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_property_named_ref_that_is_not_a_reference_response_body_for_content_types**](../../paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md) | +[**post_ref_in_additionalproperties_response_body_for_content_types**](../../paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md) | +[**post_ref_in_allof_response_body_for_content_types**](../../paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md) | +[**post_ref_in_anyof_response_body_for_content_types**](../../paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md) | +[**post_ref_in_items_response_body_for_content_types**](../../paths/response_body_post_ref_in_items_response_body_for_content_types/post.md) | +[**post_ref_in_not_response_body_for_content_types**](../../paths/response_body_post_ref_in_not_response_body_for_content_types/post.md) | +[**post_ref_in_oneof_response_body_for_content_types**](../../paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md) | +[**post_ref_in_property_response_body_for_content_types**](../../paths/response_body_post_ref_in_property_response_body_for_content_types/post.md) | +[**post_required_default_validation_response_body_for_content_types**](../../paths/response_body_post_required_default_validation_response_body_for_content_types/post.md) | +[**post_required_validation_response_body_for_content_types**](../../paths/response_body_post_required_validation_response_body_for_content_types/post.md) | +[**post_required_with_empty_array_response_body_for_content_types**](../../paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md) | +[**post_required_with_escaped_characters_response_body_for_content_types**](../../paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md) | +[**post_simple_enum_validation_response_body_for_content_types**](../../paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md) | +[**post_string_type_matches_strings_response_body_for_content_types**](../../paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) | +[**post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types**](../../paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md) | +[**post_uniqueitems_false_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) | +[**post_uniqueitems_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) | +[**post_uri_format_response_body_for_content_types**](../../paths/response_body_post_uri_format_response_body_for_content_types/post.md) | +[**post_uri_reference_format_response_body_for_content_types**](../../paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md) | +[**post_uri_template_format_response_body_for_content_types**](../../paths/response_body_post_uri_template_format_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md deleted file mode 100644 index 17de3db080b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md deleted file mode 100644 index 35bc53eeb6e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_are_allowed_by_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_are_allowed_by_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesAreAllowedByDefault](../../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_are_allowed_by_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_additionalproperties_are_allowed_by_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md deleted file mode 100644 index 6272a5d46d1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_can_exist_by_itself_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_can_exist_by_itself_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesCanExistByItself](../../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_can_exist_by_itself_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_additionalproperties_can_exist_by_itself_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md deleted file mode 100644 index d4e08257c36..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalpropertiesShouldNotLookInApplicators](../../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md deleted file mode 100644 index fe29a17081b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_combined_with_anyof_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_combined_with_anyof_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofCombinedWithAnyofOneof](../../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_combined_with_anyof_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_combined_with_anyof_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_response_body_for_content_types.md deleted file mode 100644 index 7a421b14abe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Allof](../../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md deleted file mode 100644 index 2b69a3fe300..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_simple_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_simple_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofSimpleTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofSimpleTypes](../../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_simple_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_simple_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 629f93f6887..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithBaseSchema](../../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 0b846125d61..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithOneEmptySchema](../../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 6cd511cd6bf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_first_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_first_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheFirstEmptySchema](../../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_first_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_with_the_first_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 8e341759ba9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_the_last_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_the_last_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTheLastEmptySchema](../../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_the_last_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_with_the_last_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md deleted file mode 100644 index c3a7b2a243c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_allof_with_two_empty_schemas_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_allof_with_two_empty_schemas_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AllofWithTwoEmptySchemas](../../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_allof_with_two_empty_schemas_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_allof_with_two_empty_schemas_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 91225ffe701..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofComplexTypes](../../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_anyof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md deleted file mode 100644 index 117115bdf0c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Anyof](../../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 4cedce568b6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithBaseSchema](../../../components/schema/anyof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_anyof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 8a01e38386a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_anyof_with_one_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_anyof_with_one_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnyofWithOneEmptySchema](../../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_anyof_with_one_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_anyof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md deleted file mode 100644 index 6c819ad3760..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_array_type_matches_arrays_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_array_type_matches_arrays_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_array_type_matches_arrays_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_array_type_matches_arrays_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md deleted file mode 100644 index 3464fc592c4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_boolean_type_matches_booleans_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_boolean_type_matches_booleans_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_boolean_type_matches_booleans_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_boolean_type_matches_booleans_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md deleted file mode 100644 index a5bf7c7f4e0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_int_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_int_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByIntResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByInt](../../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_int_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_by_int_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md deleted file mode 100644 index 9da037a46ec..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postByNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ByNumber](../../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_by_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md deleted file mode 100644 index 58ce3909ffe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_by_small_number_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_by_small_number_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBySmallNumberResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BySmallNumber](../../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_by_small_number_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_by_small_number_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md deleted file mode 100644 index 7a0b6a89f4f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_date_time_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_date_time_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postDateTimeFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[DateTimeFormat](../../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_date_time_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_date_time_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md deleted file mode 100644 index 79146c69677..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_email_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_email_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEmailFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EmailFormat](../../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_email_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_email_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md deleted file mode 100644 index 188ef3684c8..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with0_does_not_match_false_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with0_does_not_match_false_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith0DoesNotMatchFalse](../../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with0_does_not_match_false_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enum_with0_does_not_match_false_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md deleted file mode 100644 index 4d72f9445ee..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with1_does_not_match_true_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with1_does_not_match_true_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWith1DoesNotMatchTrue](../../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with1_does_not_match_true_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enum_with1_does_not_match_true_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index f53f7f8101a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithEscapedCharacters](../../../components/schema/enum_with_escaped_characters.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enum_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md deleted file mode 100644 index 0f7235e0a91..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_false_does_not_match0_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_false_does_not_match0_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithFalseDoesNotMatch0](../../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_false_does_not_match0_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enum_with_false_does_not_match0_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md deleted file mode 100644 index 42396c72fd1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enum_with_true_does_not_match1_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enum_with_true_does_not_match1_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumWithTrueDoesNotMatch1](../../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enum_with_true_does_not_match1_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enum_with_true_does_not_match1_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md deleted file mode 100644 index c6579022ae3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_enums_in_properties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_enums_in_properties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postEnumsInPropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[EnumsInProperties](../../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_enums_in_properties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_enums_in_properties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md deleted file mode 100644 index b832d92c872..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_forbidden_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_forbidden_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postForbiddenPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ForbiddenProperty](../../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_forbidden_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_forbidden_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md deleted file mode 100644 index ce134c2bccf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_hostname_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_hostname_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postHostnameFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HostnameFormat](../../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_hostname_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_hostname_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md deleted file mode 100644 index e1e5b18e081..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_integer_type_matches_integers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_integer_type_matches_integers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_integer_type_matches_integers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_integer_type_matches_integers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md deleted file mode 100644 index 33e3302b1db..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md deleted file mode 100644 index 80dc5d753d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_invalid_string_value_for_default_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_invalid_string_value_for_default_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[InvalidStringValueForDefault](../../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_invalid_string_value_for_default_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_invalid_string_value_for_default_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md deleted file mode 100644 index 7f481b460b0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv4_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv4_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv4FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv4Format](../../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv4_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ipv4_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md deleted file mode 100644 index f01dce24d14..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ipv6_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ipv6_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIpv6FormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Ipv6Format](../../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ipv6_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ipv6_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md deleted file mode 100644 index 4eb49649710..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_json_pointer_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_json_pointer_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postJsonPointerFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JsonPointerFormat](../../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_json_pointer_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_json_pointer_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md deleted file mode 100644 index 0343f696db1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidation](../../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maximum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md deleted file mode 100644 index 7e155360e0d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maximum_validation_with_unsigned_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maximum_validation_with_unsigned_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaximumValidationWithUnsignedInteger](../../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maximum_validation_with_unsigned_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maximum_validation_with_unsigned_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md deleted file mode 100644 index 011e007aa8e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxitemsValidation](../../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maxitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md deleted file mode 100644 index 0a185ea5349..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxlengthValidation](../../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maxlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md deleted file mode 100644 index 5e1c8d6d24d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties0_means_the_object_is_empty_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Maxproperties0MeansTheObjectIsEmpty](../../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties0_means_the_object_is_empty_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maxproperties0_means_the_object_is_empty_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 1a3970575a4..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_maxproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_maxproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MaxpropertiesValidation](../../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_maxproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_maxproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md deleted file mode 100644 index 1ae2f034192..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidation](../../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_minimum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md deleted file mode 100644 index 141bd9891d2..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minimum_validation_with_signed_integer_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minimum_validation_with_signed_integer_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinimumValidationWithSignedInteger](../../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minimum_validation_with_signed_integer_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_minimum_validation_with_signed_integer_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md deleted file mode 100644 index 9ddcb5d9b82..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinitemsValidation](../../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_minitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md deleted file mode 100644 index e76c71dbbcd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minlength_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minlength_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinlengthValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinlengthValidation](../../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minlength_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_minlength_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md deleted file mode 100644 index 6e4f8fc4e56..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_minproperties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_minproperties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postMinpropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[MinpropertiesValidation](../../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_minproperties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_minproperties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 0d828a255ea..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_allof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_allof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAllofToCheckValidationSemantics](../../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_allof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_nested_allof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index e42712bc457..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_anyof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedAnyofToCheckValidationSemantics](../../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_anyof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_nested_anyof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md deleted file mode 100644 index 7a4094cbc32..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedItems](../../../components/schema/nested_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_nested_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md deleted file mode 100644 index 22459014dc7..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nested_oneof_to_check_validation_semantics_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NestedOneofToCheckValidationSemantics](../../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nested_oneof_to_check_validation_semantics_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_nested_oneof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md deleted file mode 100644 index 7331e547110..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_more_complex_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_more_complex_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NotMoreComplexSchema](../../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_more_complex_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_not_more_complex_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_response_body_for_content_types.md deleted file mode 100644 index b589417dbc0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[_Not](../../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md deleted file mode 100644 index c718c95869c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_nul_characters_in_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_nul_characters_in_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNulCharactersInStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NulCharactersInStrings](../../../components/schema/nul_characters_in_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_nul_characters_in_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_nul_characters_in_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md deleted file mode 100644 index 42e31697bc9..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_null_type_matches_only_the_null_object_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md deleted file mode 100644 index d7bdf70bec5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_number_type_matches_numbers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_number_type_matches_numbers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_number_type_matches_numbers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_number_type_matches_numbers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md deleted file mode 100644 index d89cfd0b77f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_properties_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_properties_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectPropertiesValidation](../../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_properties_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_object_properties_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md deleted file mode 100644 index c1ed73ca24b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_object_type_matches_objects_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_type_matches_objects_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_type_matches_objects_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_object_type_matches_objects_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md deleted file mode 100644 index 8abbdf6f129..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_complex_types_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_complex_types_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofComplexTypesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofComplexTypes](../../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_complex_types_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_oneof_complex_types_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md deleted file mode 100644 index 897f3371c57..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Oneof](../../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md deleted file mode 100644 index 40b642a254d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_base_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_base_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithBaseSchema](../../../components/schema/oneof_with_base_schema.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_base_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_oneof_with_base_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md deleted file mode 100644 index 0bc4427b7d1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_empty_schema_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_empty_schema_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithEmptySchema](../../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_empty_schema_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_oneof_with_empty_schema_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md deleted file mode 100644 index 2c5e0fffa3f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_oneof_with_required_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_oneof_with_required_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postOneofWithRequiredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[OneofWithRequired](../../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_oneof_with_required_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_oneof_with_required_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md deleted file mode 100644 index dc233c84b44..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_is_not_anchored_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_is_not_anchored_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternIsNotAnchored](../../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_is_not_anchored_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_pattern_is_not_anchored_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md deleted file mode 100644 index ae2d41b5a2d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_pattern_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_pattern_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPatternValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PatternValidation](../../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_pattern_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_pattern_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 0639d86444d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_properties_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_properties_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertiesWithEscapedCharacters](../../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_properties_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_properties_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md deleted file mode 100644 index 24e8b035524..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_property_named_ref_that_is_not_a_reference_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[PropertyNamedRefThatIsNotAReference](../../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_property_named_ref_that_is_not_a_reference_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_property_named_ref_that_is_not_a_reference_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md deleted file mode 100644 index de546003978..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_additionalproperties_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_additionalproperties_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAdditionalproperties](../../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_additionalproperties_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_additionalproperties_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md deleted file mode 100644 index a0e52fad298..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_allof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_allof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAllofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAllof](../../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_allof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_allof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md deleted file mode 100644 index d2b48d83be3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_anyof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_anyof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInAnyofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInAnyof](../../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_anyof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_anyof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md deleted file mode 100644 index 08591c42e9d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_items_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_items_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInItemsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInItems](../../../components/schema/ref_in_items.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_items_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_items_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md deleted file mode 100644 index 62ec25cbbab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_not_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_not_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInNotResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInNot](../../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_not_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_not_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md deleted file mode 100644 index ab7dcf47d57..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_oneof_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_oneof_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInOneofResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInOneof](../../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_oneof_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_oneof_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md deleted file mode 100644 index 88148f8a6a3..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_ref_in_property_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_ref_in_property_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRefInPropertyResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefInProperty](../../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_ref_in_property_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_ref_in_property_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md deleted file mode 100644 index 3903e0dce3d..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_default_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_default_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredDefaultValidation](../../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_default_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_required_default_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md deleted file mode 100644 index 4ad4613dc2e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredValidation](../../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_required_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md deleted file mode 100644 index 2a137f5d152..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_empty_array_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_empty_array_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEmptyArray](../../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_empty_array_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_required_with_empty_array_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md deleted file mode 100644 index 225836af65b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_required_with_escaped_characters_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_required_with_escaped_characters_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RequiredWithEscapedCharacters](../../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_required_with_escaped_characters_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_required_with_escaped_characters_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md deleted file mode 100644 index 7a03d38177c..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_simple_enum_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_simple_enum_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postSimpleEnumValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[SimpleEnumValidation](../../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_simple_enum_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_simple_enum_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md deleted file mode 100644 index 3990c378c2f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_string_type_matches_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_string_type_matches_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_string_type_matches_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_string_type_matches_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md deleted file mode 100644 index 0c9ca7ac8d1..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md deleted file mode 100644 index 4ea72a3f385..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_false_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_false_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_false_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_uniqueitems_false_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md deleted file mode 100644 index 320d39d304e..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uniqueitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_uniqueitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md deleted file mode 100644 index 09710e0dad0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriFormat](../../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_uri_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md deleted file mode 100644 index f0d6e729dbb..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_reference_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_reference_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriReferenceFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriReferenceFormat](../../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_reference_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_uri_reference_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md deleted file mode 100644 index 535a735a7ab..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/response_content_content_type_schema_api/post_uri_template_format_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uri_template_format_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUriTemplateFormatResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UriTemplateFormat](../../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import response_content_content_type_schema_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = response_content_content_type_schema_api.ResponseContentContentTypeSchemaApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uri_template_format_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling ResponseContentContentTypeSchemaApi->post_uri_template_format_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../response_content_content_type_schema_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api.md index 9f6038ce678..547c75e6739 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api.md @@ -9,19 +9,19 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_array_type_matches_arrays_request_body**](type_api/post_array_type_matches_arrays_request_body.md) | -[**post_array_type_matches_arrays_response_body_for_content_types**](type_api/post_array_type_matches_arrays_response_body_for_content_types.md) | -[**post_boolean_type_matches_booleans_request_body**](type_api/post_boolean_type_matches_booleans_request_body.md) | -[**post_boolean_type_matches_booleans_response_body_for_content_types**](type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md) | -[**post_integer_type_matches_integers_request_body**](type_api/post_integer_type_matches_integers_request_body.md) | -[**post_integer_type_matches_integers_response_body_for_content_types**](type_api/post_integer_type_matches_integers_response_body_for_content_types.md) | -[**post_null_type_matches_only_the_null_object_request_body**](type_api/post_null_type_matches_only_the_null_object_request_body.md) | -[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md) | -[**post_number_type_matches_numbers_request_body**](type_api/post_number_type_matches_numbers_request_body.md) | -[**post_number_type_matches_numbers_response_body_for_content_types**](type_api/post_number_type_matches_numbers_response_body_for_content_types.md) | -[**post_object_type_matches_objects_request_body**](type_api/post_object_type_matches_objects_request_body.md) | -[**post_object_type_matches_objects_response_body_for_content_types**](type_api/post_object_type_matches_objects_response_body_for_content_types.md) | -[**post_string_type_matches_strings_request_body**](type_api/post_string_type_matches_strings_request_body.md) | -[**post_string_type_matches_strings_response_body_for_content_types**](type_api/post_string_type_matches_strings_response_body_for_content_types.md) | +[**post_array_type_matches_arrays_request_body**](../../paths/request_body_post_array_type_matches_arrays_request_body/post.md) | +[**post_array_type_matches_arrays_response_body_for_content_types**](../../paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md) | +[**post_boolean_type_matches_booleans_request_body**](../../paths/request_body_post_boolean_type_matches_booleans_request_body/post.md) | +[**post_boolean_type_matches_booleans_response_body_for_content_types**](../../paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md) | +[**post_integer_type_matches_integers_request_body**](../../paths/request_body_post_integer_type_matches_integers_request_body/post.md) | +[**post_integer_type_matches_integers_response_body_for_content_types**](../../paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md) | +[**post_null_type_matches_only_the_null_object_request_body**](../../paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md) | +[**post_null_type_matches_only_the_null_object_response_body_for_content_types**](../../paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md) | +[**post_number_type_matches_numbers_request_body**](../../paths/request_body_post_number_type_matches_numbers_request_body/post.md) | +[**post_number_type_matches_numbers_response_body_for_content_types**](../../paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md) | +[**post_object_type_matches_objects_request_body**](../../paths/request_body_post_object_type_matches_objects_request_body/post.md) | +[**post_object_type_matches_objects_response_body_for_content_types**](../../paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md) | +[**post_string_type_matches_strings_request_body**](../../paths/request_body_post_string_type_matches_strings_request_body/post.md) | +[**post_string_type_matches_strings_response_body_for_content_types**](../../paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_request_body.md deleted file mode 100644 index 16bcd0ee5d5..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_request_body.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **post_array_type_matches_arrays_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postArrayTypeMatchesArraysRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = array_type_matches_arrays.ArrayTypeMatchesArrays([ - None - ]) - try: - api_response = api_instance.post_array_type_matches_arrays_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_array_type_matches_arrays_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_response_body_for_content_types.md deleted file mode 100644 index 5c60bf887c0..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_array_type_matches_arrays_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_array_type_matches_arrays_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayTypeMatchesArrays](../../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_array_type_matches_arrays_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_array_type_matches_arrays_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_request_body.md deleted file mode 100644 index 960cae22194..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_boolean_type_matches_booleans_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postBooleanTypeMatchesBooleansRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = boolean_type_matches_booleans.BooleanTypeMatchesBooleans(True) - try: - api_response = api_instance.post_boolean_type_matches_booleans_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_boolean_type_matches_booleans_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md deleted file mode 100644 index 58bb8ebf6c6..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_boolean_type_matches_booleans_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_boolean_type_matches_booleans_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[BooleanTypeMatchesBooleans](../../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_boolean_type_matches_booleans_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_boolean_type_matches_booleans_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_request_body.md deleted file mode 100644 index 1dc2130d07f..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_integer_type_matches_integers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postIntegerTypeMatchesIntegersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = integer_type_matches_integers.IntegerTypeMatchesIntegers(1) - try: - api_response = api_instance.post_integer_type_matches_integers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_integer_type_matches_integers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_response_body_for_content_types.md deleted file mode 100644 index 501c06fdb32..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_integer_type_matches_integers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_integer_type_matches_integers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[IntegerTypeMatchesIntegers](../../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_integer_type_matches_integers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_integer_type_matches_integers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_request_body.md deleted file mode 100644 index 55a6baf025a..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), None] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = null_type_matches_only_the_null_object.NullTypeMatchesOnlyTheNullObject(None) - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_null_type_matches_only_the_null_object_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md deleted file mode 100644 index b7191ab13fe..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_null_type_matches_only_the_null_object_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_null_type_matches_only_the_null_object_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NullTypeMatchesOnlyTheNullObject](../../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_null_type_matches_only_the_null_object_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_null_type_matches_only_the_null_object_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_request_body.md deleted file mode 100644 index 5d2a24c4812..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_number_type_matches_numbers_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postNumberTypeMatchesNumbersRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = number_type_matches_numbers.NumberTypeMatchesNumbers(3.14) - try: - api_response = api_instance.post_number_type_matches_numbers_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_number_type_matches_numbers_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_response_body_for_content_types.md deleted file mode 100644 index a40a4f170ad..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_number_type_matches_numbers_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_number_type_matches_numbers_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberTypeMatchesNumbers](../../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_number_type_matches_numbers_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_number_type_matches_numbers_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_request_body.md deleted file mode 100644 index 36c42940884..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_object_type_matches_objects_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postObjectTypeMatchesObjectsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = object_type_matches_objects.ObjectTypeMatchesObjects() - try: - api_response = api_instance.post_object_type_matches_objects_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_object_type_matches_objects_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_response_body_for_content_types.md deleted file mode 100644 index eb20565f907..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_object_type_matches_objects_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_object_type_matches_objects_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectTypeMatchesObjects](../../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_object_type_matches_objects_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_object_type_matches_objects_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_request_body.md deleted file mode 100644 index 6719fe3e98b..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_string_type_matches_strings_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postStringTypeMatchesStringsRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example passing only required values which don't have defaults set - body = string_type_matches_strings.StringTypeMatchesStrings("string_example") - try: - api_response = api_instance.post_string_type_matches_strings_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_string_type_matches_strings_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_response_body_for_content_types.md deleted file mode 100644 index f6351fc6a40..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/type_api/post_string_type_matches_strings_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_string_type_matches_strings_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringTypeMatchesStrings](../../../components/schema/string_type_matches_strings.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import type_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = type_api.TypeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_string_type_matches_strings_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling TypeApi->post_string_type_matches_strings_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../type_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api.md index 90a00a6adec..8c687b43559 100644 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api.md +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api.md @@ -9,9 +9,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_uniqueitems_false_validation_request_body**](unique_items_api/post_uniqueitems_false_validation_request_body.md) | -[**post_uniqueitems_false_validation_response_body_for_content_types**](unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md) | -[**post_uniqueitems_validation_request_body**](unique_items_api/post_uniqueitems_validation_request_body.md) | -[**post_uniqueitems_validation_response_body_for_content_types**](unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md) | +[**post_uniqueitems_false_validation_request_body**](../../paths/request_body_post_uniqueitems_false_validation_request_body/post.md) | +[**post_uniqueitems_false_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md) | +[**post_uniqueitems_validation_request_body**](../../paths/request_body_post_uniqueitems_validation_request_body/post.md) | +[**post_uniqueitems_validation_response_body_for_content_types**](../../paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_request_body.md deleted file mode 100644 index ef70fbb06bd..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_false_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsFalseValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import unique_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = unique_items_api.UniqueItemsApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_false_validation.UniqueitemsFalseValidation(None) - try: - api_response = api_instance.post_uniqueitems_false_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling UniqueItemsApi->post_uniqueitems_false_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../unique_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md deleted file mode 100644 index 2d567d9abdf..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_false_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_false_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsFalseValidation](../../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import unique_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = unique_items_api.UniqueItemsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_false_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling UniqueItemsApi->post_uniqueitems_false_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../unique_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_request_body.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_request_body.md deleted file mode 100644 index 80082085dad..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_request_body.md +++ /dev/null @@ -1,98 +0,0 @@ - -# **post_uniqueitems_validation_request_body** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/requestBody/postUniqueitemsValidationRequestBody" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import unique_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = unique_items_api.UniqueItemsApi(api_client) - - # example passing only required values which don't have defaults set - body = uniqueitems_validation.UniqueitemsValidation(None) - try: - api_response = api_instance.post_uniqueitems_validation_request_body( - body=body, - ) - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling UniqueItemsApi->post_uniqueitems_validation_request_body: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../unique_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md deleted file mode 100644 index 5ab63aa0159..00000000000 --- a/samples/openapi3/client/3_0_3_unit_test/python/docs/apis/tags/unique_items_api/post_uniqueitems_validation_response_body_for_content_types.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **post_uniqueitems_validation_response_body_for_content_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/responseBody/postUniqueitemsValidationResponseBodyForContentTypes" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[UniqueitemsValidation](../../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = https://someserver.com/v1 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import unit_test_api -from unit_test_api.configurations import api_configuration -from unit_test_api.apis.tags import unique_items_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with unit_test_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = unique_items_api.UniqueItemsApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.post_uniqueitems_validation_response_body_for_content_types() - pprint(api_response) - except unit_test_api.ApiException as e: - print("Exception when calling UniqueItemsApi->post_uniqueitems_validation_response_body_for_content_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../unique_items_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/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 b/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 new file mode 100644 index 00000000000..727e8c3600d --- /dev/null +++ b/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 @@ -0,0 +1,115 @@ +unit_test_api.paths.request_body_post_additionalproperties_allows_a_schema_which_should_validate_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_allows_a_schema_which_should_validate_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_additionalproperties_allows_a_schema_which_should_validate_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_allows_a_schema_which_should_validate_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_allows_a_schema_which_should_validate_request_body | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody | This api is only for path=/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = additionalproperties_allows_a_schema_which_should_validate.AdditionalpropertiesAllowsASchemaWhichShouldValidate( + foo=None, + bar=None, + ) + try: + api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_additionalproperties_allows_a_schema_which_should_validate_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md new file mode 100644 index 00000000000..9ad970ee4c1 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_are_allowed_by_default_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_additionalproperties_are_allowed_by_default_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_are_allowed_by_default_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_additionalproperties_are_allowed_by_default_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_are_allowed_by_default_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_are_allowed_by_default_request_body | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAdditionalpropertiesAreAllowedByDefaultRequestBody | This api is only for path=/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAdditionalpropertiesAreAllowedByDefaultRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesAreAllowedByDefault](../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = additionalproperties_are_allowed_by_default.AdditionalpropertiesAreAllowedByDefault(None) + try: + api_response = api_instance.post_additionalproperties_are_allowed_by_default_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_additionalproperties_are_allowed_by_default_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md new file mode 100644 index 00000000000..aded269ceea --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_can_exist_by_itself_request_body/post.md @@ -0,0 +1,114 @@ +unit_test_api.paths.request_body_post_additionalproperties_can_exist_by_itself_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_can_exist_by_itself_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_additionalproperties_can_exist_by_itself_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_can_exist_by_itself_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_can_exist_by_itself_request_body | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAdditionalpropertiesCanExistByItselfRequestBody | This api is only for path=/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAdditionalpropertiesCanExistByItselfRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesCanExistByItself](../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = additionalproperties_can_exist_by_itself.AdditionalpropertiesCanExistByItself( + key=True, + ) + try: + api_response = api_instance.post_additionalproperties_can_exist_by_itself_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_additionalproperties_can_exist_by_itself_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md new file mode 100644 index 00000000000..229c81ab21e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_additionalproperties_should_not_look_in_applicators_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_additionalproperties_should_not_look_in_applicators_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_should_not_look_in_applicators_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_additionalproperties_should_not_look_in_applicators_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_should_not_look_in_applicators_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_should_not_look_in_applicators_request_body | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAdditionalpropertiesShouldNotLookInApplicatorsRequestBody | This api is only for path=/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAdditionalpropertiesShouldNotLookInApplicatorsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesShouldNotLookInApplicators](../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = additionalproperties_should_not_look_in_applicators.AdditionalpropertiesShouldNotLookInApplicators(None) + try: + api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_additionalproperties_should_not_look_in_applicators_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md new file mode 100644 index 00000000000..41df672949f --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_combined_with_anyof_oneof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_combined_with_anyof_oneof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_combined_with_anyof_oneof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_combined_with_anyof_oneof_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_combined_with_anyof_oneof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_combined_with_anyof_oneof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofCombinedWithAnyofOneofRequestBody | This api is only for path=/requestBody/postAllofCombinedWithAnyofOneofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofCombinedWithAnyofOneofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofCombinedWithAnyofOneof](../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_combined_with_anyof_oneof.AllofCombinedWithAnyofOneof(None) + try: + api_response = api_instance.post_allof_combined_with_anyof_oneof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_combined_with_anyof_oneof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_request_body/post.md new file mode 100644 index 00000000000..c8e85ed8d68 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofRequestBody | This api is only for path=/requestBody/postAllofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Allof](../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof.Allof(None) + try: + api_response = api_instance.post_allof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_simple_types_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_simple_types_request_body/post.md new file mode 100644 index 00000000000..d6437993018 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_simple_types_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_simple_types_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_simple_types_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_simple_types_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_simple_types_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_simple_types_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofSimpleTypesRequestBody | This api is only for path=/requestBody/postAllofSimpleTypesRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofSimpleTypesRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofSimpleTypes](../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_simple_types.AllofSimpleTypes(None) + try: + api_response = api_instance.post_allof_simple_types_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_simple_types_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_base_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_base_schema_request_body/post.md new file mode 100644 index 00000000000..39fc0a91c95 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_base_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_with_base_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_base_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_with_base_schema_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_base_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_base_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofWithBaseSchemaRequestBody | This api is only for path=/requestBody/postAllofWithBaseSchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofWithBaseSchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithBaseSchema](../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_with_base_schema.AllofWithBaseSchema({}) + try: + api_response = api_instance.post_allof_with_base_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_with_base_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md new file mode 100644 index 00000000000..b655606ad4c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_one_empty_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_with_one_empty_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_one_empty_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_with_one_empty_schema_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_one_empty_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_one_empty_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofWithOneEmptySchemaRequestBody | This api is only for path=/requestBody/postAllofWithOneEmptySchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofWithOneEmptySchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithOneEmptySchema](../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_with_one_empty_schema.AllofWithOneEmptySchema(None) + try: + api_response = api_instance.post_allof_with_one_empty_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_with_one_empty_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md new file mode 100644 index 00000000000..5cd94ee7845 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_first_empty_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_with_the_first_empty_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_the_first_empty_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_with_the_first_empty_schema_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_the_first_empty_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_the_first_empty_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofWithTheFirstEmptySchemaRequestBody | This api is only for path=/requestBody/postAllofWithTheFirstEmptySchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofWithTheFirstEmptySchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTheFirstEmptySchema](../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_with_the_first_empty_schema.AllofWithTheFirstEmptySchema(None) + try: + api_response = api_instance.post_allof_with_the_first_empty_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_with_the_first_empty_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md new file mode 100644 index 00000000000..44f7fa31254 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_the_last_empty_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_with_the_last_empty_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_the_last_empty_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_with_the_last_empty_schema_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_the_last_empty_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_the_last_empty_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofWithTheLastEmptySchemaRequestBody | This api is only for path=/requestBody/postAllofWithTheLastEmptySchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofWithTheLastEmptySchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTheLastEmptySchema](../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_with_the_last_empty_schema.AllofWithTheLastEmptySchema(None) + try: + api_response = api_instance.post_allof_with_the_last_empty_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_with_the_last_empty_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md new file mode 100644 index 00000000000..e4030335bd5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_allof_with_two_empty_schemas_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_allof_with_two_empty_schemas_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_two_empty_schemas_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_allof_with_two_empty_schemas_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_two_empty_schemas_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_two_empty_schemas_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAllofWithTwoEmptySchemasRequestBody | This api is only for path=/requestBody/postAllofWithTwoEmptySchemasRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAllofWithTwoEmptySchemasRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTwoEmptySchemas](../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = allof_with_two_empty_schemas.AllofWithTwoEmptySchemas(None) + try: + api_response = api_instance.post_allof_with_two_empty_schemas_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_allof_with_two_empty_schemas_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_complex_types_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_complex_types_request_body/post.md new file mode 100644 index 00000000000..8c1bd61dfe9 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_complex_types_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_anyof_complex_types_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_complex_types_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_anyof_complex_types_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_complex_types_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_complex_types_request_body | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAnyofComplexTypesRequestBody | This api is only for path=/requestBody/postAnyofComplexTypesRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAnyofComplexTypesRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofComplexTypes](../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = anyof_complex_types.AnyofComplexTypes(None) + try: + api_response = api_instance.post_anyof_complex_types_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_anyof_complex_types_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_request_body/post.md new file mode 100644 index 00000000000..eb1a740f726 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_anyof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_anyof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_request_body | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAnyofRequestBody | This api is only for path=/requestBody/postAnyofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAnyofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Anyof](../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = anyof.Anyof(None) + try: + api_response = api_instance.post_anyof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_anyof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md new file mode 100644 index 00000000000..d12757a45c4 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_base_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_anyof_with_base_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_with_base_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_anyof_with_base_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_with_base_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_with_base_schema_request_body | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAnyofWithBaseSchemaRequestBody | This api is only for path=/requestBody/postAnyofWithBaseSchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAnyofWithBaseSchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofWithBaseSchema](../../components/schema/anyof_with_base_schema.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = anyof_with_base_schema.AnyofWithBaseSchema("string_example") + try: + api_response = api_instance.post_anyof_with_base_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_anyof_with_base_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md new file mode 100644 index 00000000000..a4605cf74f5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_anyof_with_one_empty_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_anyof_with_one_empty_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_with_one_empty_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_anyof_with_one_empty_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_with_one_empty_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_with_one_empty_schema_request_body | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostAnyofWithOneEmptySchemaRequestBody | This api is only for path=/requestBody/postAnyofWithOneEmptySchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postAnyofWithOneEmptySchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofWithOneEmptySchema](../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = anyof_with_one_empty_schema.AnyofWithOneEmptySchema(None) + try: + api_response = api_instance.post_anyof_with_one_empty_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_anyof_with_one_empty_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md new file mode 100644 index 00000000000..08b3d9639c6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_array_type_matches_arrays_request_body/post.md @@ -0,0 +1,114 @@ +unit_test_api.paths.request_body_post_array_type_matches_arrays_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_array_type_matches_arrays_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_array_type_matches_arrays_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_array_type_matches_arrays_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_array_type_matches_arrays_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostArrayTypeMatchesArraysRequestBody | This api is only for path=/requestBody/postArrayTypeMatchesArraysRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postArrayTypeMatchesArraysRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ArrayTypeMatchesArrays](../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = array_type_matches_arrays.ArrayTypeMatchesArrays([ + None + ]) + try: + api_response = api_instance.post_array_type_matches_arrays_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_array_type_matches_arrays_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md new file mode 100644 index 00000000000..700d615e0b8 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_boolean_type_matches_booleans_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_boolean_type_matches_booleans_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_boolean_type_matches_booleans_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_boolean_type_matches_booleans_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_boolean_type_matches_booleans_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_boolean_type_matches_booleans_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostBooleanTypeMatchesBooleansRequestBody | This api is only for path=/requestBody/postBooleanTypeMatchesBooleansRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postBooleanTypeMatchesBooleansRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[BooleanTypeMatchesBooleans](../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = boolean_type_matches_booleans.BooleanTypeMatchesBooleans(True) + try: + api_response = api_instance.post_boolean_type_matches_booleans_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_boolean_type_matches_booleans_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_int_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_int_request_body/post.md new file mode 100644 index 00000000000..f5603ce1426 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_int_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_by_int_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_int_request_body | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_int_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_by_int_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_int_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostByIntRequestBody | This api is only for path=/requestBody/postByIntRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postByIntRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ByInt](../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example passing only required values which don't have defaults set + body = by_int.ByInt(None) + try: + api_response = api_instance.post_by_int_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_int_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_number_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_number_request_body/post.md new file mode 100644 index 00000000000..db9675ea6f4 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_number_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_by_number_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_number_request_body | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_number_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_by_number_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_number_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostByNumberRequestBody | This api is only for path=/requestBody/postByNumberRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postByNumberRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ByNumber](../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example passing only required values which don't have defaults set + body = by_number.ByNumber(None) + try: + api_response = api_instance.post_by_number_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_number_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_small_number_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_small_number_request_body/post.md new file mode 100644 index 00000000000..d7745378d63 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_by_small_number_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_by_small_number_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_small_number_request_body | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_small_number_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_by_small_number_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_small_number_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostBySmallNumberRequestBody | This api is only for path=/requestBody/postBySmallNumberRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postBySmallNumberRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[BySmallNumber](../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example passing only required values which don't have defaults set + body = by_small_number.BySmallNumber(None) + try: + api_response = api_instance.post_by_small_number_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_small_number_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_date_time_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_date_time_format_request_body/post.md new file mode 100644 index 00000000000..221be49389e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_date_time_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_date_time_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_date_time_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_date_time_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_date_time_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_date_time_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostDateTimeFormatRequestBody | This api is only for path=/requestBody/postDateTimeFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postDateTimeFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[DateTimeFormat](../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = date_time_format.DateTimeFormat(None) + try: + api_response = api_instance.post_date_time_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_date_time_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_email_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_email_format_request_body/post.md new file mode 100644 index 00000000000..735d3a200ac --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_email_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_email_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_email_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_email_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_email_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_email_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEmailFormatRequestBody | This api is only for path=/requestBody/postEmailFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEmailFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EmailFormat](../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = email_format.EmailFormat(None) + try: + api_response = api_instance.post_email_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_email_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md new file mode 100644 index 00000000000..3af87d19aaf --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with0_does_not_match_false_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_enum_with0_does_not_match_false_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with0_does_not_match_false_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enum_with0_does_not_match_false_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with0_does_not_match_false_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with0_does_not_match_false_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumWith0DoesNotMatchFalseRequestBody | This api is only for path=/requestBody/postEnumWith0DoesNotMatchFalseRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumWith0DoesNotMatchFalseRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWith0DoesNotMatchFalse](../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enum_with0_does_not_match_false.EnumWith0DoesNotMatchFalse(0) + try: + api_response = api_instance.post_enum_with0_does_not_match_false_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enum_with0_does_not_match_false_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md new file mode 100644 index 00000000000..0e00df7fcb5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with1_does_not_match_true_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_enum_with1_does_not_match_true_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with1_does_not_match_true_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enum_with1_does_not_match_true_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with1_does_not_match_true_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with1_does_not_match_true_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumWith1DoesNotMatchTrueRequestBody | This api is only for path=/requestBody/postEnumWith1DoesNotMatchTrueRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumWith1DoesNotMatchTrueRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWith1DoesNotMatchTrue](../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enum_with1_does_not_match_true.EnumWith1DoesNotMatchTrue(1) + try: + api_response = api_instance.post_enum_with1_does_not_match_true_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enum_with1_does_not_match_true_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md new file mode 100644 index 00000000000..2c3c0b9418d --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_escaped_characters_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_enum_with_escaped_characters_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_escaped_characters_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enum_with_escaped_characters_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_escaped_characters_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_escaped_characters_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumWithEscapedCharactersRequestBody | This api is only for path=/requestBody/postEnumWithEscapedCharactersRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumWithEscapedCharactersRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithEscapedCharacters](../../components/schema/enum_with_escaped_characters.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enum_with_escaped_characters.EnumWithEscapedCharacters("foo\nbar") + try: + api_response = api_instance.post_enum_with_escaped_characters_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enum_with_escaped_characters_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md new file mode 100644 index 00000000000..2c2a3d4c2c6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_false_does_not_match0_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_enum_with_false_does_not_match0_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_false_does_not_match0_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enum_with_false_does_not_match0_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_false_does_not_match0_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_false_does_not_match0_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumWithFalseDoesNotMatch0RequestBody | This api is only for path=/requestBody/postEnumWithFalseDoesNotMatch0RequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumWithFalseDoesNotMatch0RequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithFalseDoesNotMatch0](../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enum_with_false_does_not_match0.EnumWithFalseDoesNotMatch0(False) + try: + api_response = api_instance.post_enum_with_false_does_not_match0_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enum_with_false_does_not_match0_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md new file mode 100644 index 00000000000..492f9e1d936 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enum_with_true_does_not_match1_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_enum_with_true_does_not_match1_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_true_does_not_match1_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enum_with_true_does_not_match1_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_true_does_not_match1_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_true_does_not_match1_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumWithTrueDoesNotMatch1RequestBody | This api is only for path=/requestBody/postEnumWithTrueDoesNotMatch1RequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumWithTrueDoesNotMatch1RequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), bool] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithTrueDoesNotMatch1](../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enum_with_true_does_not_match1.EnumWithTrueDoesNotMatch1(True) + try: + api_response = api_instance.post_enum_with_true_does_not_match1_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enum_with_true_does_not_match1_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enums_in_properties_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enums_in_properties_request_body/post.md new file mode 100644 index 00000000000..120f35413aa --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_enums_in_properties_request_body/post.md @@ -0,0 +1,115 @@ +unit_test_api.paths.request_body_post_enums_in_properties_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enums_in_properties_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_enums_in_properties_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enums_in_properties_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enums_in_properties_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostEnumsInPropertiesRequestBody | This api is only for path=/requestBody/postEnumsInPropertiesRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postEnumsInPropertiesRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumsInProperties](../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = enums_in_properties.EnumsInProperties( + foo="foo", + bar="bar", + ) + try: + api_response = api_instance.post_enums_in_properties_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_enums_in_properties_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_forbidden_property_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_forbidden_property_request_body/post.md new file mode 100644 index 00000000000..03154ad3d40 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_forbidden_property_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_forbidden_property_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_forbidden_property_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_forbidden_property_request_body | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_forbidden_property_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_forbidden_property_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostForbiddenPropertyRequestBody | This api is only for path=/requestBody/postForbiddenPropertyRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postForbiddenPropertyRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ForbiddenProperty](../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = forbidden_property.ForbiddenProperty(None) + try: + api_response = api_instance.post_forbidden_property_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_forbidden_property_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_hostname_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_hostname_format_request_body/post.md new file mode 100644 index 00000000000..5e5fddc957d --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_hostname_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_hostname_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_hostname_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_hostname_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_hostname_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_hostname_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostHostnameFormatRequestBody | This api is only for path=/requestBody/postHostnameFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postHostnameFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[HostnameFormat](../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = hostname_format.HostnameFormat(None) + try: + api_response = api_instance.post_hostname_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_hostname_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md new file mode 100644 index 00000000000..f88eb4025bf --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_integer_type_matches_integers_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_integer_type_matches_integers_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_integer_type_matches_integers_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_integer_type_matches_integers_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_integer_type_matches_integers_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_integer_type_matches_integers_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostIntegerTypeMatchesIntegersRequestBody | This api is only for path=/requestBody/postIntegerTypeMatchesIntegersRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postIntegerTypeMatchesIntegersRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[IntegerTypeMatchesIntegers](../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = integer_type_matches_integers.IntegerTypeMatchesIntegers(1) + try: + api_response = api_instance.post_integer_type_matches_integers_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_integer_type_matches_integers_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md new file mode 100644 index 00000000000..517ae1d3dda --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody | This api is only for path=/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example passing only required values which don't have defaults set + body = invalid_instance_should_not_raise_error_when_float_division_inf.InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf(1) + try: + api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md new file mode 100644 index 00000000000..55ac8af9f6f --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_invalid_string_value_for_default_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_invalid_string_value_for_default_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_invalid_string_value_for_default_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_invalid_string_value_for_default_request_body | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| post_invalid_string_value_for_default_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_invalid_string_value_for_default_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostInvalidStringValueForDefaultRequestBody | This api is only for path=/requestBody/postInvalidStringValueForDefaultRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postInvalidStringValueForDefaultRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[InvalidStringValueForDefault](../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = invalid_string_value_for_default.InvalidStringValueForDefault(None) + try: + api_response = api_instance.post_invalid_string_value_for_default_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_invalid_string_value_for_default_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv4_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv4_format_request_body/post.md new file mode 100644 index 00000000000..719c947b429 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv4_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ipv4_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ipv4_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ipv4_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ipv4_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ipv4_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostIpv4FormatRequestBody | This api is only for path=/requestBody/postIpv4FormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postIpv4FormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Ipv4Format](../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ipv4_format.Ipv4Format(None) + try: + api_response = api_instance.post_ipv4_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ipv4_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv6_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv6_format_request_body/post.md new file mode 100644 index 00000000000..b4c3ce386b3 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ipv6_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ipv6_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ipv6_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ipv6_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ipv6_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ipv6_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostIpv6FormatRequestBody | This api is only for path=/requestBody/postIpv6FormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postIpv6FormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Ipv6Format](../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ipv6_format.Ipv6Format(None) + try: + api_response = api_instance.post_ipv6_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ipv6_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_json_pointer_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_json_pointer_format_request_body/post.md new file mode 100644 index 00000000000..64f9ba5ccca --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_json_pointer_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_json_pointer_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_json_pointer_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_json_pointer_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_json_pointer_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_json_pointer_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostJsonPointerFormatRequestBody | This api is only for path=/requestBody/postJsonPointerFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postJsonPointerFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[JsonPointerFormat](../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = json_pointer_format.JsonPointerFormat(None) + try: + api_response = api_instance.post_json_pointer_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_json_pointer_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_request_body/post.md new file mode 100644 index 00000000000..911b29132e5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maximum_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maximum_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maximum_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maximum_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maximum_validation_request_body | [MaximumApi](../../apis/tags/maximum_api.md) | This api is only for tag=maximum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaximumValidationRequestBody | This api is only for path=/requestBody/postMaximumValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaximumValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaximumValidation](../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maximum_validation.MaximumValidation(None) + try: + api_response = api_instance.post_maximum_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maximum_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaximumApi API]](../../apis/tags/maximum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md new file mode 100644 index 00000000000..e1806c507e7 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maximum_validation_with_unsigned_integer_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maximum_validation_with_unsigned_integer_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maximum_validation_with_unsigned_integer_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maximum_validation_with_unsigned_integer_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maximum_validation_with_unsigned_integer_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maximum_validation_with_unsigned_integer_request_body | [MaximumApi](../../apis/tags/maximum_api.md) | This api is only for tag=maximum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaximumValidationWithUnsignedIntegerRequestBody | This api is only for path=/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaximumValidationWithUnsignedIntegerRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaximumValidationWithUnsignedInteger](../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maximum_validation_with_unsigned_integer.MaximumValidationWithUnsignedInteger(None) + try: + api_response = api_instance.post_maximum_validation_with_unsigned_integer_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maximum_validation_with_unsigned_integer_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaximumApi API]](../../apis/tags/maximum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxitems_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxitems_validation_request_body/post.md new file mode 100644 index 00000000000..4924c5ac812 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxitems_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maxitems_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxitems_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maxitems_validation_request_body | [MaxItemsApi](../../apis/tags/max_items_api.md) | This api is only for tag=maxItems | +| post_maxitems_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxitems_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaxitemsValidationRequestBody | This api is only for path=/requestBody/postMaxitemsValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaxitemsValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxitemsValidation](../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maxitems_validation.MaxitemsValidation(None) + try: + api_response = api_instance.post_maxitems_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maxitems_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to MaxItemsApi API]](../../apis/tags/max_items_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxlength_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxlength_validation_request_body/post.md new file mode 100644 index 00000000000..fbb1674a0b1 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxlength_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maxlength_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxlength_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maxlength_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxlength_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxlength_validation_request_body | [MaxLengthApi](../../apis/tags/max_length_api.md) | This api is only for tag=maxLength | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaxlengthValidationRequestBody | This api is only for path=/requestBody/postMaxlengthValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaxlengthValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxlengthValidation](../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maxlength_validation.MaxlengthValidation(None) + try: + api_response = api_instance.post_maxlength_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maxlength_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaxLengthApi API]](../../apis/tags/max_length_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md new file mode 100644 index 00000000000..066037f2884 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties0_means_the_object_is_empty_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maxproperties0_means_the_object_is_empty_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxproperties0_means_the_object_is_empty_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maxproperties0_means_the_object_is_empty_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxproperties0_means_the_object_is_empty_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxproperties0_means_the_object_is_empty_request_body | [MaxPropertiesApi](../../apis/tags/max_properties_api.md) | This api is only for tag=maxProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaxproperties0MeansTheObjectIsEmptyRequestBody | This api is only for path=/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaxproperties0MeansTheObjectIsEmptyRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Maxproperties0MeansTheObjectIsEmpty](../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maxproperties0_means_the_object_is_empty.Maxproperties0MeansTheObjectIsEmpty(None) + try: + api_response = api_instance.post_maxproperties0_means_the_object_is_empty_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maxproperties0_means_the_object_is_empty_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaxPropertiesApi API]](../../apis/tags/max_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties_validation_request_body/post.md new file mode 100644 index 00000000000..4aa1f11d0be --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_maxproperties_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_maxproperties_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxproperties_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_maxproperties_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxproperties_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxproperties_validation_request_body | [MaxPropertiesApi](../../apis/tags/max_properties_api.md) | This api is only for tag=maxProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMaxpropertiesValidationRequestBody | This api is only for path=/requestBody/postMaxpropertiesValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMaxpropertiesValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxpropertiesValidation](../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = maxproperties_validation.MaxpropertiesValidation(None) + try: + api_response = api_instance.post_maxproperties_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_maxproperties_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaxPropertiesApi API]](../../apis/tags/max_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_request_body/post.md new file mode 100644 index 00000000000..7c5025704b9 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_minimum_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minimum_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_minimum_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minimum_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minimum_validation_request_body | [MinimumApi](../../apis/tags/minimum_api.md) | This api is only for tag=minimum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMinimumValidationRequestBody | This api is only for path=/requestBody/postMinimumValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMinimumValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinimumValidation](../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = minimum_validation.MinimumValidation(None) + try: + api_response = api_instance.post_minimum_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_minimum_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MinimumApi API]](../../apis/tags/minimum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md new file mode 100644 index 00000000000..1b70467ca70 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minimum_validation_with_signed_integer_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_minimum_validation_with_signed_integer_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minimum_validation_with_signed_integer_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_minimum_validation_with_signed_integer_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minimum_validation_with_signed_integer_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minimum_validation_with_signed_integer_request_body | [MinimumApi](../../apis/tags/minimum_api.md) | This api is only for tag=minimum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMinimumValidationWithSignedIntegerRequestBody | This api is only for path=/requestBody/postMinimumValidationWithSignedIntegerRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMinimumValidationWithSignedIntegerRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinimumValidationWithSignedInteger](../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = minimum_validation_with_signed_integer.MinimumValidationWithSignedInteger(None) + try: + api_response = api_instance.post_minimum_validation_with_signed_integer_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_minimum_validation_with_signed_integer_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MinimumApi API]](../../apis/tags/minimum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minitems_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minitems_validation_request_body/post.md new file mode 100644 index 00000000000..9e78d6768d9 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minitems_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_minitems_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minitems_validation_request_body | [MinItemsApi](../../apis/tags/min_items_api.md) | This api is only for tag=minItems | +| post_minitems_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_minitems_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minitems_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMinitemsValidationRequestBody | This api is only for path=/requestBody/postMinitemsValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMinitemsValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinitemsValidation](../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import min_items_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = min_items_api.MinItemsApi(api_client) + + # example passing only required values which don't have defaults set + body = minitems_validation.MinitemsValidation(None) + try: + api_response = api_instance.post_minitems_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MinItemsApi->post_minitems_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MinItemsApi API]](../../apis/tags/min_items_api.md) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minlength_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minlength_validation_request_body/post.md new file mode 100644 index 00000000000..ba39e2bd906 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minlength_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_minlength_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minlength_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_minlength_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minlength_validation_request_body | [MinLengthApi](../../apis/tags/min_length_api.md) | This api is only for tag=minLength | +| post_minlength_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMinlengthValidationRequestBody | This api is only for path=/requestBody/postMinlengthValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMinlengthValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinlengthValidation](../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = minlength_validation.MinlengthValidation(None) + try: + api_response = api_instance.post_minlength_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_minlength_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to MinLengthApi API]](../../apis/tags/min_length_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minproperties_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minproperties_validation_request_body/post.md new file mode 100644 index 00000000000..ee903caf28c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_minproperties_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_minproperties_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minproperties_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_minproperties_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minproperties_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minproperties_validation_request_body | [MinPropertiesApi](../../apis/tags/min_properties_api.md) | This api is only for tag=minProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostMinpropertiesValidationRequestBody | This api is only for path=/requestBody/postMinpropertiesValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postMinpropertiesValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinpropertiesValidation](../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = minproperties_validation.MinpropertiesValidation(None) + try: + api_response = api_instance.post_minproperties_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_minproperties_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MinPropertiesApi API]](../../apis/tags/min_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md new file mode 100644 index 00000000000..c421472bdcb --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_allof_to_check_validation_semantics_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_nested_allof_to_check_validation_semantics_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_allof_to_check_validation_semantics_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_nested_allof_to_check_validation_semantics_request_body | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_nested_allof_to_check_validation_semantics_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_allof_to_check_validation_semantics_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNestedAllofToCheckValidationSemanticsRequestBody | This api is only for path=/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNestedAllofToCheckValidationSemanticsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedAllofToCheckValidationSemantics](../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = nested_allof_to_check_validation_semantics.NestedAllofToCheckValidationSemantics(None) + try: + api_response = api_instance.post_nested_allof_to_check_validation_semantics_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_nested_allof_to_check_validation_semantics_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md new file mode 100644 index 00000000000..320a27b2824 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_anyof_to_check_validation_semantics_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_nested_anyof_to_check_validation_semantics_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_anyof_to_check_validation_semantics_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_nested_anyof_to_check_validation_semantics_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_anyof_to_check_validation_semantics_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_anyof_to_check_validation_semantics_request_body | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNestedAnyofToCheckValidationSemanticsRequestBody | This api is only for path=/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNestedAnyofToCheckValidationSemanticsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedAnyofToCheckValidationSemantics](../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = nested_anyof_to_check_validation_semantics.NestedAnyofToCheckValidationSemantics(None) + try: + api_response = api_instance.post_nested_anyof_to_check_validation_semantics_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_nested_anyof_to_check_validation_semantics_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_items_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_items_request_body/post.md new file mode 100644 index 00000000000..5143799edcd --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_items_request_body/post.md @@ -0,0 +1,120 @@ +unit_test_api.paths.request_body_post_nested_items_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_items_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_nested_items_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_items_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_items_request_body | [ItemsApi](../../apis/tags/items_api.md) | This api is only for tag=items | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNestedItemsRequestBody | This api is only for path=/requestBody/postNestedItemsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNestedItemsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedItems](../../components/schema/nested_items.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = nested_items.NestedItems([ + [ + [ + [ + 3.14 + ] + ] + ] + ]) + try: + api_response = api_instance.post_nested_items_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_nested_items_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ItemsApi API]](../../apis/tags/items_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md new file mode 100644 index 00000000000..9e089074c96 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nested_oneof_to_check_validation_semantics_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_nested_oneof_to_check_validation_semantics_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_oneof_to_check_validation_semantics_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_nested_oneof_to_check_validation_semantics_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_nested_oneof_to_check_validation_semantics_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_oneof_to_check_validation_semantics_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNestedOneofToCheckValidationSemanticsRequestBody | This api is only for path=/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNestedOneofToCheckValidationSemanticsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedOneofToCheckValidationSemantics](../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = nested_oneof_to_check_validation_semantics.NestedOneofToCheckValidationSemantics(None) + try: + api_response = api_instance.post_nested_oneof_to_check_validation_semantics_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_nested_oneof_to_check_validation_semantics_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_more_complex_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_more_complex_schema_request_body/post.md new file mode 100644 index 00000000000..f2324d57ecf --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_more_complex_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_not_more_complex_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_not_more_complex_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_not_more_complex_schema_request_body | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_not_more_complex_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_not_more_complex_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNotMoreComplexSchemaRequestBody | This api is only for path=/requestBody/postNotMoreComplexSchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNotMoreComplexSchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NotMoreComplexSchema](../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = not_more_complex_schema.NotMoreComplexSchema(None) + try: + api_response = api_instance.post_not_more_complex_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_not_more_complex_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_request_body/post.md new file mode 100644 index 00000000000..451be22290f --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_not_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_not_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_not_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_not_request_body | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_not_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_not_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNotRequestBody | This api is only for path=/requestBody/postNotRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNotRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[_Not](../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = _not._Not(None) + try: + api_response = api_instance.post_not_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_not_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md new file mode 100644 index 00000000000..af1e1ace3f7 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_nul_characters_in_strings_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_nul_characters_in_strings_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nul_characters_in_strings_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_nul_characters_in_strings_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nul_characters_in_strings_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nul_characters_in_strings_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNulCharactersInStringsRequestBody | This api is only for path=/requestBody/postNulCharactersInStringsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNulCharactersInStringsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NulCharactersInStrings](../../components/schema/nul_characters_in_strings.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = nul_characters_in_strings.NulCharactersInStrings("hello\x00there") + try: + api_response = api_instance.post_nul_characters_in_strings_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_nul_characters_in_strings_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md new file mode 100644 index 00000000000..7e7b1fb356c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_null_type_matches_only_the_null_object_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_null_type_matches_only_the_null_object_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_null_type_matches_only_the_null_object_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_null_type_matches_only_the_null_object_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_null_type_matches_only_the_null_object_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_null_type_matches_only_the_null_object_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNullTypeMatchesOnlyTheNullObjectRequestBody | This api is only for path=/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNullTypeMatchesOnlyTheNullObjectRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), None] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NullTypeMatchesOnlyTheNullObject](../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = null_type_matches_only_the_null_object.NullTypeMatchesOnlyTheNullObject(None) + try: + api_response = api_instance.post_null_type_matches_only_the_null_object_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_null_type_matches_only_the_null_object_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md new file mode 100644 index 00000000000..36d2d716b3f --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_number_type_matches_numbers_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_number_type_matches_numbers_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_number_type_matches_numbers_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_number_type_matches_numbers_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_number_type_matches_numbers_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_number_type_matches_numbers_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostNumberTypeMatchesNumbersRequestBody | This api is only for path=/requestBody/postNumberTypeMatchesNumbersRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postNumberTypeMatchesNumbersRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NumberTypeMatchesNumbers](../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = number_type_matches_numbers.NumberTypeMatchesNumbers(3.14) + try: + api_response = api_instance.post_number_type_matches_numbers_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_number_type_matches_numbers_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_properties_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_properties_validation_request_body/post.md new file mode 100644 index 00000000000..6f14d162294 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_properties_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_object_properties_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_object_properties_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_object_properties_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_object_properties_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_object_properties_validation_request_body | [PropertiesApi](../../apis/tags/properties_api.md) | This api is only for tag=properties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostObjectPropertiesValidationRequestBody | This api is only for path=/requestBody/postObjectPropertiesValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postObjectPropertiesValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectPropertiesValidation](../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = object_properties_validation.ObjectPropertiesValidation(None) + try: + api_response = api_instance.post_object_properties_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_object_properties_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PropertiesApi API]](../../apis/tags/properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_type_matches_objects_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_type_matches_objects_request_body/post.md new file mode 100644 index 00000000000..0972255c574 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_object_type_matches_objects_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_object_type_matches_objects_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_object_type_matches_objects_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_object_type_matches_objects_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_object_type_matches_objects_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_object_type_matches_objects_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostObjectTypeMatchesObjectsRequestBody | This api is only for path=/requestBody/postObjectTypeMatchesObjectsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postObjectTypeMatchesObjectsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectTypeMatchesObjects](../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = object_type_matches_objects.ObjectTypeMatchesObjects() + try: + api_response = api_instance.post_object_type_matches_objects_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_object_type_matches_objects_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_complex_types_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_complex_types_request_body/post.md new file mode 100644 index 00000000000..9a6aef783c1 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_complex_types_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_oneof_complex_types_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_complex_types_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_oneof_complex_types_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_complex_types_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_complex_types_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostOneofComplexTypesRequestBody | This api is only for path=/requestBody/postOneofComplexTypesRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postOneofComplexTypesRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofComplexTypes](../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = oneof_complex_types.OneofComplexTypes(None) + try: + api_response = api_instance.post_oneof_complex_types_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_oneof_complex_types_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_request_body/post.md new file mode 100644 index 00000000000..6755642c719 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_oneof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_oneof_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostOneofRequestBody | This api is only for path=/requestBody/postOneofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postOneofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Oneof](../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = oneof.Oneof(None) + try: + api_response = api_instance.post_oneof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_oneof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md new file mode 100644 index 00000000000..967adb1d065 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_base_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_oneof_with_base_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_base_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_oneof_with_base_schema_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_base_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_base_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostOneofWithBaseSchemaRequestBody | This api is only for path=/requestBody/postOneofWithBaseSchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postOneofWithBaseSchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithBaseSchema](../../components/schema/oneof_with_base_schema.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = oneof_with_base_schema.OneofWithBaseSchema("string_example") + try: + api_response = api_instance.post_oneof_with_base_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_oneof_with_base_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md new file mode 100644 index 00000000000..e80bfa4dc33 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_empty_schema_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_oneof_with_empty_schema_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_empty_schema_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_oneof_with_empty_schema_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_empty_schema_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_empty_schema_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostOneofWithEmptySchemaRequestBody | This api is only for path=/requestBody/postOneofWithEmptySchemaRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postOneofWithEmptySchemaRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithEmptySchema](../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = oneof_with_empty_schema.OneofWithEmptySchema(None) + try: + api_response = api_instance.post_oneof_with_empty_schema_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_oneof_with_empty_schema_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_required_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_required_request_body/post.md new file mode 100644 index 00000000000..9ebdc8bef5d --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_oneof_with_required_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_oneof_with_required_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_required_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_oneof_with_required_request_body | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_required_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_required_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostOneofWithRequiredRequestBody | This api is only for path=/requestBody/postOneofWithRequiredRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postOneofWithRequiredRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithRequired](../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = oneof_with_required.OneofWithRequired() + try: + api_response = api_instance.post_oneof_with_required_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_oneof_with_required_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md new file mode 100644 index 00000000000..5166ab70e5d --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_is_not_anchored_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_pattern_is_not_anchored_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_pattern_is_not_anchored_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_pattern_is_not_anchored_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_pattern_is_not_anchored_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_pattern_is_not_anchored_request_body | [PatternApi](../../apis/tags/pattern_api.md) | This api is only for tag=pattern | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostPatternIsNotAnchoredRequestBody | This api is only for path=/requestBody/postPatternIsNotAnchoredRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postPatternIsNotAnchoredRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PatternIsNotAnchored](../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = pattern_is_not_anchored.PatternIsNotAnchored(None) + try: + api_response = api_instance.post_pattern_is_not_anchored_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_pattern_is_not_anchored_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PatternApi API]](../../apis/tags/pattern_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_validation_request_body/post.md new file mode 100644 index 00000000000..200d193dd33 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_pattern_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_pattern_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_pattern_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_pattern_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_pattern_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_pattern_validation_request_body | [PatternApi](../../apis/tags/pattern_api.md) | This api is only for tag=pattern | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostPatternValidationRequestBody | This api is only for path=/requestBody/postPatternValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postPatternValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PatternValidation](../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = pattern_validation.PatternValidation(None) + try: + api_response = api_instance.post_pattern_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_pattern_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PatternApi API]](../../apis/tags/pattern_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md new file mode 100644 index 00000000000..e2b084b6e52 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_properties_with_escaped_characters_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_properties_with_escaped_characters_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_properties_with_escaped_characters_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_properties_with_escaped_characters_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_properties_with_escaped_characters_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_properties_with_escaped_characters_request_body | [PropertiesApi](../../apis/tags/properties_api.md) | This api is only for tag=properties | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostPropertiesWithEscapedCharactersRequestBody | This api is only for path=/requestBody/postPropertiesWithEscapedCharactersRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postPropertiesWithEscapedCharactersRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PropertiesWithEscapedCharacters](../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = properties_with_escaped_characters.PropertiesWithEscapedCharacters(None) + try: + api_response = api_instance.post_properties_with_escaped_characters_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_properties_with_escaped_characters_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PropertiesApi API]](../../apis/tags/properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md new file mode 100644 index 00000000000..efd01108017 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_property_named_ref_that_is_not_a_reference_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_property_named_ref_that_is_not_a_reference_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_property_named_ref_that_is_not_a_reference_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_property_named_ref_that_is_not_a_reference_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_property_named_ref_that_is_not_a_reference_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_property_named_ref_that_is_not_a_reference_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostPropertyNamedRefThatIsNotAReferenceRequestBody | This api is only for path=/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postPropertyNamedRefThatIsNotAReferenceRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PropertyNamedRefThatIsNotAReference](../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) + try: + api_response = api_instance.post_property_named_ref_that_is_not_a_reference_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_property_named_ref_that_is_not_a_reference_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md new file mode 100644 index 00000000000..85c64883098 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_additionalproperties_request_body/post.md @@ -0,0 +1,114 @@ +unit_test_api.paths.request_body_post_ref_in_additionalproperties_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_additionalproperties_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_additionalproperties_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_additionalproperties_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_additionalproperties_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInAdditionalpropertiesRequestBody | This api is only for path=/requestBody/postRefInAdditionalpropertiesRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInAdditionalpropertiesRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAdditionalproperties](../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_additionalproperties.RefInAdditionalproperties( + key=property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None), + ) + try: + api_response = api_instance.post_ref_in_additionalproperties_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_additionalproperties_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_allof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_allof_request_body/post.md new file mode 100644 index 00000000000..cf55f0c363e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_allof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ref_in_allof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_allof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_allof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_allof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_allof_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInAllofRequestBody | This api is only for path=/requestBody/postRefInAllofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInAllofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAllof](../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_allof.RefInAllof(None) + try: + api_response = api_instance.post_ref_in_allof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_allof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_anyof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_anyof_request_body/post.md new file mode 100644 index 00000000000..2e9ea6e6fb8 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_anyof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ref_in_anyof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_anyof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_anyof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_anyof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_anyof_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInAnyofRequestBody | This api is only for path=/requestBody/postRefInAnyofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInAnyofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAnyof](../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_anyof.RefInAnyof(None) + try: + api_response = api_instance.post_ref_in_anyof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_anyof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_items_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_items_request_body/post.md new file mode 100644 index 00000000000..bc75bc2675c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_items_request_body/post.md @@ -0,0 +1,114 @@ +unit_test_api.paths.request_body_post_ref_in_items_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_items_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_items_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_items_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_items_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInItemsRequestBody | This api is only for path=/requestBody/postRefInItemsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInItemsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), list, tuple] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInItems](../../components/schema/ref_in_items.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_items.RefInItems([ + property_named_ref_that_is_not_a_reference.PropertyNamedRefThatIsNotAReference(None) + ]) + try: + api_response = api_instance.post_ref_in_items_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_items_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_not_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_not_request_body/post.md new file mode 100644 index 00000000000..f35b696eb28 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_not_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ref_in_not_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_not_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_not_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_not_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_not_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInNotRequestBody | This api is only for path=/requestBody/postRefInNotRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInNotRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInNot](../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_not.RefInNot(None) + try: + api_response = api_instance.post_ref_in_not_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_not_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_oneof_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_oneof_request_body/post.md new file mode 100644 index 00000000000..9b8e8ed9012 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_oneof_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ref_in_oneof_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_oneof_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_oneof_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_oneof_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_oneof_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInOneofRequestBody | This api is only for path=/requestBody/postRefInOneofRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInOneofRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInOneof](../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_oneof.RefInOneof(None) + try: + api_response = api_instance.post_ref_in_oneof_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_oneof_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_property_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_property_request_body/post.md new file mode 100644 index 00000000000..d503b1532e7 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_ref_in_property_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_ref_in_property_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_property_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_ref_in_property_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_property_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_property_request_body | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRefInPropertyRequestBody | This api is only for path=/requestBody/postRefInPropertyRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRefInPropertyRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInProperty](../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = ref_in_property.RefInProperty(None) + try: + api_response = api_instance.post_ref_in_property_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_ref_in_property_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_default_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_default_validation_request_body/post.md new file mode 100644 index 00000000000..956331c783e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_default_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_required_default_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_default_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_required_default_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_default_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_default_validation_request_body | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRequiredDefaultValidationRequestBody | This api is only for path=/requestBody/postRequiredDefaultValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRequiredDefaultValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredDefaultValidation](../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = required_default_validation.RequiredDefaultValidation(None) + try: + api_response = api_instance.post_required_default_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_required_default_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_validation_request_body/post.md new file mode 100644 index 00000000000..00adaef9793 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_required_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_required_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_validation_request_body | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRequiredValidationRequestBody | This api is only for path=/requestBody/postRequiredValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRequiredValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredValidation](../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = required_validation.RequiredValidation(None) + try: + api_response = api_instance.post_required_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_required_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_empty_array_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_empty_array_request_body/post.md new file mode 100644 index 00000000000..eb221c60e23 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_empty_array_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_required_with_empty_array_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_with_empty_array_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_required_with_empty_array_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_with_empty_array_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_with_empty_array_request_body | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRequiredWithEmptyArrayRequestBody | This api is only for path=/requestBody/postRequiredWithEmptyArrayRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRequiredWithEmptyArrayRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredWithEmptyArray](../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = required_with_empty_array.RequiredWithEmptyArray(None) + try: + api_response = api_instance.post_required_with_empty_array_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_required_with_empty_array_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md new file mode 100644 index 00000000000..6f18d086f26 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_required_with_escaped_characters_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_required_with_escaped_characters_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_with_escaped_characters_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_required_with_escaped_characters_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_with_escaped_characters_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_with_escaped_characters_request_body | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostRequiredWithEscapedCharactersRequestBody | This api is only for path=/requestBody/postRequiredWithEscapedCharactersRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postRequiredWithEscapedCharactersRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredWithEscapedCharacters](../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = required_with_escaped_characters.RequiredWithEscapedCharacters(None) + try: + api_response = api_instance.post_required_with_escaped_characters_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_required_with_escaped_characters_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_simple_enum_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_simple_enum_validation_request_body/post.md new file mode 100644 index 00000000000..26c2345e8d3 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_simple_enum_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_simple_enum_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_simple_enum_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_simple_enum_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_simple_enum_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_simple_enum_validation_request_body | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostSimpleEnumValidationRequestBody | This api is only for path=/requestBody/postSimpleEnumValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postSimpleEnumValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), decimal.Decimal, int, float] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[SimpleEnumValidation](../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = simple_enum_validation.SimpleEnumValidation(1) + try: + api_response = api_instance.post_simple_enum_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_simple_enum_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_string_type_matches_strings_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_string_type_matches_strings_request_body/post.md new file mode 100644 index 00000000000..a99a0560cae --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_string_type_matches_strings_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_string_type_matches_strings_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_string_type_matches_strings_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_string_type_matches_strings_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_string_type_matches_strings_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_string_type_matches_strings_request_body | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostStringTypeMatchesStringsRequestBody | This api is only for path=/requestBody/postStringTypeMatchesStringsRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postStringTypeMatchesStringsRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), str] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[StringTypeMatchesStrings](../../components/schema/string_type_matches_strings.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = string_type_matches_strings.StringTypeMatchesStrings("string_example") + try: + api_response = api_instance.post_string_type_matches_strings_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_string_type_matches_strings_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md new file mode 100644 index 00000000000..b767cf1146b --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body/post.md @@ -0,0 +1,114 @@ +unit_test_api.paths.request_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody | This api is only for path=/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = the_default_keyword_does_not_do_anything_if_the_property_is_missing.TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing( + alpha=5, + ) + try: + api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md new file mode 100644 index 00000000000..c09c9ee533b --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_false_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_uniqueitems_false_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uniqueitems_false_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_uniqueitems_false_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uniqueitems_false_validation_request_body | [UniqueItemsApi](../../apis/tags/unique_items_api.md) | This api is only for tag=uniqueItems | +| post_uniqueitems_false_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostUniqueitemsFalseValidationRequestBody | This api is only for path=/requestBody/postUniqueitemsFalseValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postUniqueitemsFalseValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UniqueitemsFalseValidation](../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = uniqueitems_false_validation.UniqueitemsFalseValidation(None) + try: + api_response = api_instance.post_uniqueitems_false_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_uniqueitems_false_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to UniqueItemsApi API]](../../apis/tags/unique_items_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_validation_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_validation_request_body/post.md new file mode 100644 index 00000000000..3a56f8cb938 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uniqueitems_validation_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_uniqueitems_validation_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uniqueitems_validation_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_uniqueitems_validation_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uniqueitems_validation_request_body | [UniqueItemsApi](../../apis/tags/unique_items_api.md) | This api is only for tag=uniqueItems | +| post_uniqueitems_validation_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostUniqueitemsValidationRequestBody | This api is only for path=/requestBody/postUniqueitemsValidationRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postUniqueitemsValidationRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UniqueitemsValidation](../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = uniqueitems_validation.UniqueitemsValidation(None) + try: + api_response = api_instance.post_uniqueitems_validation_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_uniqueitems_validation_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to UniqueItemsApi API]](../../apis/tags/unique_items_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_format_request_body/post.md new file mode 100644 index 00000000000..c855d1f26f6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_uri_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_uri_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostUriFormatRequestBody | This api is only for path=/requestBody/postUriFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postUriFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriFormat](../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = uri_format.UriFormat(None) + try: + api_response = api_instance.post_uri_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_uri_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_reference_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_reference_format_request_body/post.md new file mode 100644 index 00000000000..476323a0822 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_reference_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_uri_reference_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_reference_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_uri_reference_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_reference_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_reference_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostUriReferenceFormatRequestBody | This api is only for path=/requestBody/postUriReferenceFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postUriReferenceFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriReferenceFormat](../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = uri_reference_format.UriReferenceFormat(None) + try: + api_response = api_instance.post_uri_reference_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_uri_reference_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_template_format_request_body/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_template_format_request_body/post.md new file mode 100644 index 00000000000..f3371266c38 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/request_body_post_uri_template_format_request_body/post.md @@ -0,0 +1,112 @@ +unit_test_api.paths.request_body_post_uri_template_format_request_body.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_template_format_request_body | [OperationRequestBodyApi](../../apis/tags/operation_request_body_api.md) | This api is only for tag=operation.requestBody | +| post_uri_template_format_request_body | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_template_format_request_body | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_template_format_request_body | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post | ApiForPost | This api is only for this endpoint | +| post | RequestBodyPostUriTemplateFormatRequestBody | This api is only for path=/requestBody/postUriTemplateFormatRequestBody | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/requestBody/postUriTemplateFormatRequestBody" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriTemplateFormat](../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import operation_request_body_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = operation_request_body_api.OperationRequestBodyApi(api_client) + + # example passing only required values which don't have defaults set + body = uri_template_format.UriTemplateFormat(None) + try: + api_response = api_instance.post_uri_template_format_request_body( + body=body, + ) + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OperationRequestBodyApi->post_uri_template_format_request_body: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OperationRequestBodyApi API]](../../apis/tags/operation_request_body_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ead30777d51 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes | This api is only for path=/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAdditionalpropertiesAllowsASchemaWhichShouldValidateResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesAllowsASchemaWhichShouldValidate](../../components/schema/additionalproperties_allows_a_schema_which_should_validate.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_additionalproperties_allows_a_schema_which_should_validate_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md new file mode 100644 index 00000000000..88a0c33d874 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_additionalproperties_are_allowed_by_default_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_are_allowed_by_default_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_are_allowed_by_default_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_are_allowed_by_default_response_body_for_content_types | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post_additionalproperties_are_allowed_by_default_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes | This api is only for path=/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAdditionalpropertiesAreAllowedByDefaultResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesAreAllowedByDefault](../../components/schema/additionalproperties_are_allowed_by_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_additionalproperties_are_allowed_by_default_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_additionalproperties_are_allowed_by_default_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md new file mode 100644 index 00000000000..dd6432d1c27 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_additionalproperties_can_exist_by_itself_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_can_exist_by_itself_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_can_exist_by_itself_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_can_exist_by_itself_response_body_for_content_types | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post_additionalproperties_can_exist_by_itself_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes | This api is only for path=/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAdditionalpropertiesCanExistByItselfResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesCanExistByItself](../../components/schema/additionalproperties_can_exist_by_itself.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_additionalproperties_can_exist_by_itself_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_additionalproperties_can_exist_by_itself_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md new file mode 100644 index 00000000000..a029c51a095 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types | [AdditionalPropertiesApi](../../apis/tags/additional_properties_api.md) | This api is only for tag=additionalProperties | +| post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes | This api is only for path=/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAdditionalpropertiesShouldNotLookInApplicatorsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalpropertiesShouldNotLookInApplicators](../../components/schema/additionalproperties_should_not_look_in_applicators.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_additionalproperties_should_not_look_in_applicators_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AdditionalPropertiesApi API]](../../apis/tags/additional_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..d6c8de85370 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_combined_with_anyof_oneof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_combined_with_anyof_oneof_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_combined_with_anyof_oneof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_combined_with_anyof_oneof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_combined_with_anyof_oneof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofCombinedWithAnyofOneofResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofCombinedWithAnyofOneofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofCombinedWithAnyofOneof](../../components/schema/allof_combined_with_anyof_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_combined_with_anyof_oneof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_combined_with_anyof_oneof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..dd148e48816 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Allof](../../components/schema/allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ab27c118e56 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_simple_types_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_simple_types_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_simple_types_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_simple_types_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_simple_types_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_simple_types_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofSimpleTypesResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofSimpleTypesResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofSimpleTypesResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofSimpleTypes](../../components/schema/allof_simple_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_simple_types_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_simple_types_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..53bce21ad43 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_base_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_with_base_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_base_schema_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_base_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_base_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_with_base_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofWithBaseSchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofWithBaseSchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithBaseSchema](../../components/schema/allof_with_base_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_with_base_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_with_base_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..02170dccdc9 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_one_empty_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_with_one_empty_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_one_empty_schema_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_one_empty_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_one_empty_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_with_one_empty_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofWithOneEmptySchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofWithOneEmptySchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithOneEmptySchema](../../components/schema/allof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_with_one_empty_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..bf05b52c4fc --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_with_the_first_empty_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_the_first_empty_schema_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_the_first_empty_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_the_first_empty_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_with_the_first_empty_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofWithTheFirstEmptySchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofWithTheFirstEmptySchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTheFirstEmptySchema](../../components/schema/allof_with_the_first_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_with_the_first_empty_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_with_the_first_empty_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..6deda618e6b --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_with_the_last_empty_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_the_last_empty_schema_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_the_last_empty_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_the_last_empty_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_with_the_last_empty_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofWithTheLastEmptySchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofWithTheLastEmptySchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTheLastEmptySchema](../../components/schema/allof_with_the_last_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_with_the_last_empty_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_with_the_last_empty_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md new file mode 100644 index 00000000000..3128db1cc81 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_allof_with_two_empty_schemas_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_allof_with_two_empty_schemas_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_allof_with_two_empty_schemas_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_allof_with_two_empty_schemas_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_allof_with_two_empty_schemas_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_allof_with_two_empty_schemas_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAllofWithTwoEmptySchemasResponseBodyForContentTypes | This api is only for path=/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAllofWithTwoEmptySchemasResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AllofWithTwoEmptySchemas](../../components/schema/allof_with_two_empty_schemas.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_allof_with_two_empty_schemas_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_allof_with_two_empty_schemas_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md new file mode 100644 index 00000000000..bdb4c013d92 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_complex_types_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_anyof_complex_types_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_complex_types_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_complex_types_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_complex_types_response_body_for_content_types | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post_anyof_complex_types_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAnyofComplexTypesResponseBodyForContentTypes | This api is only for path=/responseBody/postAnyofComplexTypesResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAnyofComplexTypesResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofComplexTypes](../../components/schema/anyof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_anyof_complex_types_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_anyof_complex_types_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..65347e563d6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_anyof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_response_body_for_content_types | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post_anyof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAnyofResponseBodyForContentTypes | This api is only for path=/responseBody/postAnyofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAnyofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Anyof](../../components/schema/anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_anyof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_anyof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..f83f7b0cd7e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_base_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_anyof_with_base_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_with_base_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_with_base_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_with_base_schema_response_body_for_content_types | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post_anyof_with_base_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAnyofWithBaseSchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAnyofWithBaseSchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofWithBaseSchema](../../components/schema/anyof_with_base_schema.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_anyof_with_base_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_anyof_with_base_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..59de3997f1e --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_anyof_with_one_empty_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_anyof_with_one_empty_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_anyof_with_one_empty_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_anyof_with_one_empty_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_anyof_with_one_empty_schema_response_body_for_content_types | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post_anyof_with_one_empty_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostAnyofWithOneEmptySchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postAnyofWithOneEmptySchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnyofWithOneEmptySchema](../../components/schema/anyof_with_one_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_anyof_with_one_empty_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_anyof_with_one_empty_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md new file mode 100644 index 00000000000..c7c0b1dfa59 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_array_type_matches_arrays_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_array_type_matches_arrays_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_array_type_matches_arrays_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_array_type_matches_arrays_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_array_type_matches_arrays_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_array_type_matches_arrays_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostArrayTypeMatchesArraysResponseBodyForContentTypes | This api is only for path=/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postArrayTypeMatchesArraysResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ArrayTypeMatchesArrays](../../components/schema/array_type_matches_arrays.md) | list, tuple | tuple | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_array_type_matches_arrays_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_array_type_matches_arrays_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md new file mode 100644 index 00000000000..144f9278eea --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_boolean_type_matches_booleans_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_boolean_type_matches_booleans_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_boolean_type_matches_booleans_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_boolean_type_matches_booleans_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_boolean_type_matches_booleans_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_boolean_type_matches_booleans_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostBooleanTypeMatchesBooleansResponseBodyForContentTypes | This api is only for path=/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postBooleanTypeMatchesBooleansResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[BooleanTypeMatchesBooleans](../../components/schema/boolean_type_matches_booleans.md) | bool | BoolClass | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_boolean_type_matches_booleans_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_boolean_type_matches_booleans_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_int_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_int_response_body_for_content_types/post.md new file mode 100644 index 00000000000..911e70f70a0 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_int_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_by_int_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_int_response_body_for_content_types | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_int_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_int_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_by_int_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostByIntResponseBodyForContentTypes | This api is only for path=/responseBody/postByIntResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postByIntResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ByInt](../../components/schema/by_int.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_by_int_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_int_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_number_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_number_response_body_for_content_types/post.md new file mode 100644 index 00000000000..d9ce9671ace --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_number_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_by_number_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_number_response_body_for_content_types | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_number_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_number_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_by_number_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostByNumberResponseBodyForContentTypes | This api is only for path=/responseBody/postByNumberResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postByNumberResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ByNumber](../../components/schema/by_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_by_number_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_number_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md new file mode 100644 index 00000000000..1ed6ac259ce --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_by_small_number_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_by_small_number_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_by_small_number_response_body_for_content_types | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_by_small_number_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_by_small_number_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_by_small_number_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostBySmallNumberResponseBodyForContentTypes | This api is only for path=/responseBody/postBySmallNumberResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postBySmallNumberResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[BySmallNumber](../../components/schema/by_small_number.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_by_small_number_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_by_small_number_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..93cc18dcc66 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_date_time_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_date_time_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_date_time_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_date_time_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_date_time_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_date_time_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostDateTimeFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postDateTimeFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postDateTimeFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[DateTimeFormat](../../components/schema/date_time_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_date_time_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_date_time_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_email_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_email_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..f4c783e2e98 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_email_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_email_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_email_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_email_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_email_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_email_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEmailFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postEmailFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEmailFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EmailFormat](../../components/schema/email_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_email_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_email_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md new file mode 100644 index 00000000000..c541f7c6e0a --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with0_does_not_match_false_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enum_with0_does_not_match_false_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with0_does_not_match_false_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with0_does_not_match_false_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with0_does_not_match_false_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enum_with0_does_not_match_false_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumWith0DoesNotMatchFalseResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumWith0DoesNotMatchFalseResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWith0DoesNotMatchFalse](../../components/schema/enum_with0_does_not_match_false.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enum_with0_does_not_match_false_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enum_with0_does_not_match_false_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md new file mode 100644 index 00000000000..0a9954e1429 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with1_does_not_match_true_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enum_with1_does_not_match_true_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with1_does_not_match_true_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with1_does_not_match_true_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with1_does_not_match_true_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enum_with1_does_not_match_true_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumWith1DoesNotMatchTrueResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumWith1DoesNotMatchTrueResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWith1DoesNotMatchTrue](../../components/schema/enum_with1_does_not_match_true.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enum_with1_does_not_match_true_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enum_with1_does_not_match_true_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md new file mode 100644 index 00000000000..97bf7dd5de4 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_escaped_characters_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enum_with_escaped_characters_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_escaped_characters_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_escaped_characters_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_escaped_characters_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enum_with_escaped_characters_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumWithEscapedCharactersResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumWithEscapedCharactersResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithEscapedCharacters](../../components/schema/enum_with_escaped_characters.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enum_with_escaped_characters_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enum_with_escaped_characters_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md new file mode 100644 index 00000000000..1ccf7c9fc79 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_false_does_not_match0_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enum_with_false_does_not_match0_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_false_does_not_match0_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_false_does_not_match0_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_false_does_not_match0_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enum_with_false_does_not_match0_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumWithFalseDoesNotMatch0ResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithFalseDoesNotMatch0](../../components/schema/enum_with_false_does_not_match0.md) | bool | BoolClass | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enum_with_false_does_not_match0_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enum_with_false_does_not_match0_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ebf91f8d446 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enum_with_true_does_not_match1_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enum_with_true_does_not_match1_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enum_with_true_does_not_match1_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enum_with_true_does_not_match1_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enum_with_true_does_not_match1_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enum_with_true_does_not_match1_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumWithTrueDoesNotMatch1ResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumWithTrueDoesNotMatch1](../../components/schema/enum_with_true_does_not_match1.md) | bool | BoolClass | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enum_with_true_does_not_match1_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enum_with_true_does_not_match1_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ceb7feb0fd3 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_enums_in_properties_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_enums_in_properties_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_enums_in_properties_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_enums_in_properties_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_enums_in_properties_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_enums_in_properties_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostEnumsInPropertiesResponseBodyForContentTypes | This api is only for path=/responseBody/postEnumsInPropertiesResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postEnumsInPropertiesResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[EnumsInProperties](../../components/schema/enums_in_properties.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_enums_in_properties_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_enums_in_properties_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md new file mode 100644 index 00000000000..5478c27dd18 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_forbidden_property_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_forbidden_property_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_forbidden_property_response_body_for_content_types | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_forbidden_property_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_forbidden_property_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_forbidden_property_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostForbiddenPropertyResponseBodyForContentTypes | This api is only for path=/responseBody/postForbiddenPropertyResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postForbiddenPropertyResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ForbiddenProperty](../../components/schema/forbidden_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import _not_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = _not_api._NotApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_forbidden_property_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling _NotApi->post_forbidden_property_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..92d57a05030 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_hostname_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_hostname_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_hostname_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_hostname_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_hostname_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_hostname_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostHostnameFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postHostnameFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postHostnameFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[HostnameFormat](../../components/schema/hostname_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_hostname_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_hostname_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md new file mode 100644 index 00000000000..f83273146f7 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_integer_type_matches_integers_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_integer_type_matches_integers_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_integer_type_matches_integers_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_integer_type_matches_integers_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_integer_type_matches_integers_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_integer_type_matches_integers_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostIntegerTypeMatchesIntegersResponseBodyForContentTypes | This api is only for path=/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postIntegerTypeMatchesIntegersResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[IntegerTypeMatchesIntegers](../../components/schema/integer_type_matches_integers.md) | decimal.Decimal, int | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_integer_type_matches_integers_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_integer_type_matches_integers_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md new file mode 100644 index 00000000000..89c9192692c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types | [MultipleOfApi](../../apis/tags/multiple_of_api.md) | This api is only for tag=multipleOf | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes | This api is only for path=/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postInvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInfResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[InvalidInstanceShouldNotRaiseErrorWhenFloatDivisionInf](../../components/schema/invalid_instance_should_not_raise_error_when_float_division_inf.md) | decimal.Decimal, int | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import multiple_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = multiple_of_api.MultipleOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MultipleOfApi->post_invalid_instance_should_not_raise_error_when_float_division_inf_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MultipleOfApi API]](../../apis/tags/multiple_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md new file mode 100644 index 00000000000..604ba06c005 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_invalid_string_value_for_default_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_invalid_string_value_for_default_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_invalid_string_value_for_default_response_body_for_content_types | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| post_invalid_string_value_for_default_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_invalid_string_value_for_default_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_invalid_string_value_for_default_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostInvalidStringValueForDefaultResponseBodyForContentTypes | This api is only for path=/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postInvalidStringValueForDefaultResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[InvalidStringValueForDefault](../../components/schema/invalid_string_value_for_default.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import default_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_invalid_string_value_for_default_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling DefaultApi->post_invalid_string_value_for_default_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..d2bdcceb039 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv4_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ipv4_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ipv4_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ipv4_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ipv4_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_ipv4_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostIpv4FormatResponseBodyForContentTypes | This api is only for path=/responseBody/postIpv4FormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postIpv4FormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Ipv4Format](../../components/schema/ipv4_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ipv4_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ipv4_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..6fceb235a0b --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ipv6_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ipv6_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ipv6_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ipv6_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ipv6_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_ipv6_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostIpv6FormatResponseBodyForContentTypes | This api is only for path=/responseBody/postIpv6FormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postIpv6FormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Ipv6Format](../../components/schema/ipv6_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ipv6_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ipv6_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..c3dcb2023f5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_json_pointer_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_json_pointer_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_json_pointer_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_json_pointer_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_json_pointer_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_json_pointer_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostJsonPointerFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postJsonPointerFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postJsonPointerFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[JsonPointerFormat](../../components/schema/json_pointer_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_json_pointer_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_json_pointer_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..cfd636fe5f5 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maximum_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maximum_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maximum_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maximum_validation_response_body_for_content_types | [MaximumApi](../../apis/tags/maximum_api.md) | This api is only for tag=maximum | +| post_maximum_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaximumValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMaximumValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaximumValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaximumValidation](../../components/schema/maximum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maximum_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_maximum_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaximumApi API]](../../apis/tags/maximum_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md new file mode 100644 index 00000000000..a2c2b8c5eff --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maximum_validation_with_unsigned_integer_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maximum_validation_with_unsigned_integer_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maximum_validation_with_unsigned_integer_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maximum_validation_with_unsigned_integer_response_body_for_content_types | [MaximumApi](../../apis/tags/maximum_api.md) | This api is only for tag=maximum | +| post_maximum_validation_with_unsigned_integer_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes | This api is only for path=/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaximumValidationWithUnsignedIntegerResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaximumValidationWithUnsignedInteger](../../components/schema/maximum_validation_with_unsigned_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maximum_validation_with_unsigned_integer_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_maximum_validation_with_unsigned_integer_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaximumApi API]](../../apis/tags/maximum_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..a5528964949 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxitems_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maxitems_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxitems_validation_response_body_for_content_types | [MaxItemsApi](../../apis/tags/max_items_api.md) | This api is only for tag=maxItems | +| post_maxitems_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxitems_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxitems_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaxitemsValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMaxitemsValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaxitemsValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxitemsValidation](../../components/schema/maxitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import max_items_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = max_items_api.MaxItemsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maxitems_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MaxItemsApi->post_maxitems_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MaxItemsApi API]](../../apis/tags/max_items_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ccf5d208c05 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxlength_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maxlength_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxlength_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxlength_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxlength_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_maxlength_validation_response_body_for_content_types | [MaxLengthApi](../../apis/tags/max_length_api.md) | This api is only for tag=maxLength | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaxlengthValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMaxlengthValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaxlengthValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxlengthValidation](../../components/schema/maxlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maxlength_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_maxlength_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to MaxLengthApi API]](../../apis/tags/max_length_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md new file mode 100644 index 00000000000..0eef637e2ff --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maxproperties0_means_the_object_is_empty_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxproperties0_means_the_object_is_empty_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxproperties0_means_the_object_is_empty_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxproperties0_means_the_object_is_empty_response_body_for_content_types | [MaxPropertiesApi](../../apis/tags/max_properties_api.md) | This api is only for tag=maxProperties | +| post_maxproperties0_means_the_object_is_empty_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes | This api is only for path=/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaxproperties0MeansTheObjectIsEmptyResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Maxproperties0MeansTheObjectIsEmpty](../../components/schema/maxproperties0_means_the_object_is_empty.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maxproperties0_means_the_object_is_empty_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_maxproperties0_means_the_object_is_empty_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaxPropertiesApi API]](../../apis/tags/max_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..1b5451e9b61 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_maxproperties_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_maxproperties_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_maxproperties_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_maxproperties_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_maxproperties_validation_response_body_for_content_types | [MaxPropertiesApi](../../apis/tags/max_properties_api.md) | This api is only for tag=maxProperties | +| post_maxproperties_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMaxpropertiesValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMaxpropertiesValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MaxpropertiesValidation](../../components/schema/maxproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_maxproperties_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_maxproperties_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MaxPropertiesApi API]](../../apis/tags/max_properties_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..28044cb81bd --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_minimum_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minimum_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minimum_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minimum_validation_response_body_for_content_types | [MinimumApi](../../apis/tags/minimum_api.md) | This api is only for tag=minimum | +| post_minimum_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMinimumValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMinimumValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMinimumValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinimumValidation](../../components/schema/minimum_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_minimum_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_minimum_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MinimumApi API]](../../apis/tags/minimum_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md new file mode 100644 index 00000000000..e7858c626db --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_minimum_validation_with_signed_integer_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minimum_validation_with_signed_integer_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minimum_validation_with_signed_integer_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minimum_validation_with_signed_integer_response_body_for_content_types | [MinimumApi](../../apis/tags/minimum_api.md) | This api is only for tag=minimum | +| post_minimum_validation_with_signed_integer_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMinimumValidationWithSignedIntegerResponseBodyForContentTypes | This api is only for path=/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMinimumValidationWithSignedIntegerResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinimumValidationWithSignedInteger](../../components/schema/minimum_validation_with_signed_integer.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_minimum_validation_with_signed_integer_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_minimum_validation_with_signed_integer_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to MinimumApi API]](../../apis/tags/minimum_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..d09e4921a51 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minitems_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_minitems_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minitems_validation_response_body_for_content_types | [MinItemsApi](../../apis/tags/min_items_api.md) | This api is only for tag=minItems | +| post_minitems_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minitems_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minitems_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMinitemsValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMinitemsValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMinitemsValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinitemsValidation](../../components/schema/minitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import min_items_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = min_items_api.MinItemsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_minitems_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling MinItemsApi->post_minitems_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to MinItemsApi API]](../../apis/tags/min_items_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..a62982be109 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minlength_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_minlength_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minlength_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minlength_validation_response_body_for_content_types | [MinLengthApi](../../apis/tags/min_length_api.md) | This api is only for tag=minLength | +| post_minlength_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minlength_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMinlengthValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMinlengthValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMinlengthValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinlengthValidation](../../components/schema/minlength_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_minlength_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_minlength_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to MinLengthApi API]](../../apis/tags/min_length_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..9cf5fcbd939 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_minproperties_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_minproperties_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_minproperties_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_minproperties_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_minproperties_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_minproperties_validation_response_body_for_content_types | [MinPropertiesApi](../../apis/tags/min_properties_api.md) | This api is only for tag=minProperties | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostMinpropertiesValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postMinpropertiesValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postMinpropertiesValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[MinpropertiesValidation](../../components/schema/minproperties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_minproperties_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_minproperties_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to MinPropertiesApi API]](../../apis/tags/min_properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md new file mode 100644 index 00000000000..9fc50a6bda4 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_nested_allof_to_check_validation_semantics_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_allof_to_check_validation_semantics_response_body_for_content_types | [AllOfApi](../../apis/tags/all_of_api.md) | This api is only for tag=allOf | +| post_nested_allof_to_check_validation_semantics_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_allof_to_check_validation_semantics_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_allof_to_check_validation_semantics_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes | This api is only for path=/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNestedAllofToCheckValidationSemanticsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedAllofToCheckValidationSemantics](../../components/schema/nested_allof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import all_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = all_of_api.AllOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_nested_allof_to_check_validation_semantics_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling AllOfApi->post_nested_allof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AllOfApi API]](../../apis/tags/all_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md new file mode 100644 index 00000000000..8a3a3481308 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_nested_anyof_to_check_validation_semantics_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_anyof_to_check_validation_semantics_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_anyof_to_check_validation_semantics_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_anyof_to_check_validation_semantics_response_body_for_content_types | [AnyOfApi](../../apis/tags/any_of_api.md) | This api is only for tag=anyOf | +| post_nested_anyof_to_check_validation_semantics_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes | This api is only for path=/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNestedAnyofToCheckValidationSemanticsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedAnyofToCheckValidationSemantics](../../components/schema/nested_anyof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_nested_anyof_to_check_validation_semantics_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_nested_anyof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to AnyOfApi API]](../../apis/tags/any_of_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md new file mode 100644 index 00000000000..b9aec826871 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_items_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_nested_items_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_items_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_items_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_items_response_body_for_content_types | [ItemsApi](../../apis/tags/items_api.md) | This api is only for tag=items | +| post_nested_items_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNestedItemsResponseBodyForContentTypes | This api is only for path=/responseBody/postNestedItemsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNestedItemsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedItems](../../components/schema/nested_items.md) | list, tuple | tuple | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_nested_items_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_nested_items_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ItemsApi API]](../../apis/tags/items_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md new file mode 100644 index 00000000000..db1164c8e30 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_nested_oneof_to_check_validation_semantics_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nested_oneof_to_check_validation_semantics_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_nested_oneof_to_check_validation_semantics_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nested_oneof_to_check_validation_semantics_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nested_oneof_to_check_validation_semantics_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes | This api is only for path=/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNestedOneofToCheckValidationSemanticsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NestedOneofToCheckValidationSemantics](../../components/schema/nested_oneof_to_check_validation_semantics.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_nested_oneof_to_check_validation_semantics_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_nested_oneof_to_check_validation_semantics_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..f54ed3a09c3 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_more_complex_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_not_more_complex_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_not_more_complex_schema_response_body_for_content_types | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_not_more_complex_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_not_more_complex_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_not_more_complex_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNotMoreComplexSchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNotMoreComplexSchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NotMoreComplexSchema](../../components/schema/not_more_complex_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import _not_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = _not_api._NotApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_not_more_complex_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling _NotApi->post_not_more_complex_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_response_body_for_content_types/post.md new file mode 100644 index 00000000000..ba1d942ce54 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_not_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_not_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_not_response_body_for_content_types | [_NotApi](../../apis/tags/_not_api.md) | This api is only for tag=not | +| post_not_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_not_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_not_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNotResponseBodyForContentTypes | This api is only for path=/responseBody/postNotResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNotResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[_Not](../../components/schema/_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import _not_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = _not_api._NotApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_not_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling _NotApi->post_not_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to _NotApi API]](../../apis/tags/_not_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md new file mode 100644 index 00000000000..f5f1c426d2c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_nul_characters_in_strings_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_nul_characters_in_strings_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_nul_characters_in_strings_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_nul_characters_in_strings_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_nul_characters_in_strings_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_nul_characters_in_strings_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNulCharactersInStringsResponseBodyForContentTypes | This api is only for path=/responseBody/postNulCharactersInStringsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNulCharactersInStringsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NulCharactersInStrings](../../components/schema/nul_characters_in_strings.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_nul_characters_in_strings_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_nul_characters_in_strings_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md new file mode 100644 index 00000000000..63dd1283503 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_null_type_matches_only_the_null_object_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_null_type_matches_only_the_null_object_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_null_type_matches_only_the_null_object_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_null_type_matches_only_the_null_object_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_null_type_matches_only_the_null_object_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes | This api is only for path=/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNullTypeMatchesOnlyTheNullObjectResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NullTypeMatchesOnlyTheNullObject](../../components/schema/null_type_matches_only_the_null_object.md) | None | NoneClass | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_null_type_matches_only_the_null_object_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_null_type_matches_only_the_null_object_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md new file mode 100644 index 00000000000..4a8035c53ca --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_number_type_matches_numbers_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_number_type_matches_numbers_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_number_type_matches_numbers_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_number_type_matches_numbers_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_number_type_matches_numbers_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_number_type_matches_numbers_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostNumberTypeMatchesNumbersResponseBodyForContentTypes | This api is only for path=/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postNumberTypeMatchesNumbersResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NumberTypeMatchesNumbers](../../components/schema/number_type_matches_numbers.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_number_type_matches_numbers_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_number_type_matches_numbers_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..9968c320df6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_properties_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_object_properties_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_object_properties_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_object_properties_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_object_properties_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_object_properties_validation_response_body_for_content_types | [PropertiesApi](../../apis/tags/properties_api.md) | This api is only for tag=properties | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostObjectPropertiesValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postObjectPropertiesValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectPropertiesValidation](../../components/schema/object_properties_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_object_properties_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_object_properties_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to PropertiesApi API]](../../apis/tags/properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md new file mode 100644 index 00000000000..e71dc7b5e5c --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_object_type_matches_objects_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_object_type_matches_objects_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_object_type_matches_objects_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_object_type_matches_objects_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_object_type_matches_objects_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_object_type_matches_objects_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostObjectTypeMatchesObjectsResponseBodyForContentTypes | This api is only for path=/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postObjectTypeMatchesObjectsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectTypeMatchesObjects](../../components/schema/object_type_matches_objects.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_object_type_matches_objects_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_object_type_matches_objects_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md new file mode 100644 index 00000000000..cc22c26ac80 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_complex_types_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_oneof_complex_types_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_complex_types_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_complex_types_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_complex_types_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_oneof_complex_types_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostOneofComplexTypesResponseBodyForContentTypes | This api is only for path=/responseBody/postOneofComplexTypesResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postOneofComplexTypesResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofComplexTypes](../../components/schema/oneof_complex_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_oneof_complex_types_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_oneof_complex_types_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..5a0e4c8ed27 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_oneof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_oneof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostOneofResponseBodyForContentTypes | This api is only for path=/responseBody/postOneofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postOneofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Oneof](../../components/schema/oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_oneof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_oneof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..4c9aa21512a --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_base_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_oneof_with_base_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_base_schema_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_base_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_base_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_oneof_with_base_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostOneofWithBaseSchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postOneofWithBaseSchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithBaseSchema](../../components/schema/oneof_with_base_schema.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_oneof_with_base_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_oneof_with_base_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md new file mode 100644 index 00000000000..0366e46e0bb --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_empty_schema_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_oneof_with_empty_schema_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_empty_schema_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_empty_schema_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_empty_schema_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_oneof_with_empty_schema_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostOneofWithEmptySchemaResponseBodyForContentTypes | This api is only for path=/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postOneofWithEmptySchemaResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithEmptySchema](../../components/schema/oneof_with_empty_schema.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_oneof_with_empty_schema_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_oneof_with_empty_schema_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md new file mode 100644 index 00000000000..6465e67acd8 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_oneof_with_required_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_oneof_with_required_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_oneof_with_required_response_body_for_content_types | [OneOfApi](../../apis/tags/one_of_api.md) | This api is only for tag=oneOf | +| post_oneof_with_required_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_oneof_with_required_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_oneof_with_required_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostOneofWithRequiredResponseBodyForContentTypes | This api is only for path=/responseBody/postOneofWithRequiredResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postOneofWithRequiredResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[OneofWithRequired](../../components/schema/oneof_with_required.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import one_of_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = one_of_api.OneOfApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_oneof_with_required_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling OneOfApi->post_oneof_with_required_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to OneOfApi API]](../../apis/tags/one_of_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md new file mode 100644 index 00000000000..124c28eea9b --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_is_not_anchored_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_pattern_is_not_anchored_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_pattern_is_not_anchored_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_pattern_is_not_anchored_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_pattern_is_not_anchored_response_body_for_content_types | [PatternApi](../../apis/tags/pattern_api.md) | This api is only for tag=pattern | +| post_pattern_is_not_anchored_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostPatternIsNotAnchoredResponseBodyForContentTypes | This api is only for path=/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postPatternIsNotAnchoredResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PatternIsNotAnchored](../../components/schema/pattern_is_not_anchored.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_pattern_is_not_anchored_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_pattern_is_not_anchored_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PatternApi API]](../../apis/tags/pattern_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..02cf3f92172 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_pattern_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_pattern_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_pattern_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_pattern_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_pattern_validation_response_body_for_content_types | [PatternApi](../../apis/tags/pattern_api.md) | This api is only for tag=pattern | +| post_pattern_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostPatternValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postPatternValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postPatternValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PatternValidation](../../components/schema/pattern_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_pattern_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_pattern_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to PatternApi API]](../../apis/tags/pattern_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md new file mode 100644 index 00000000000..adcc874f408 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_properties_with_escaped_characters_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_properties_with_escaped_characters_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_properties_with_escaped_characters_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_properties_with_escaped_characters_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_properties_with_escaped_characters_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_properties_with_escaped_characters_response_body_for_content_types | [PropertiesApi](../../apis/tags/properties_api.md) | This api is only for tag=properties | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostPropertiesWithEscapedCharactersResponseBodyForContentTypes | This api is only for path=/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postPropertiesWithEscapedCharactersResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PropertiesWithEscapedCharacters](../../components/schema/properties_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_properties_with_escaped_characters_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_properties_with_escaped_characters_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to PropertiesApi API]](../../apis/tags/properties_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md new file mode 100644 index 00000000000..5798d76fa85 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_property_named_ref_that_is_not_a_reference_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_property_named_ref_that_is_not_a_reference_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_property_named_ref_that_is_not_a_reference_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_property_named_ref_that_is_not_a_reference_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_property_named_ref_that_is_not_a_reference_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes | This api is only for path=/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postPropertyNamedRefThatIsNotAReferenceResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[PropertyNamedRefThatIsNotAReference](../../components/schema/property_named_ref_that_is_not_a_reference.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_property_named_ref_that_is_not_a_reference_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_property_named_ref_that_is_not_a_reference_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md new file mode 100644 index 00000000000..0c06a3e0402 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_additionalproperties_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_additionalproperties_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_additionalproperties_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_additionalproperties_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_additionalproperties_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_additionalproperties_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInAdditionalpropertiesResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInAdditionalpropertiesResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAdditionalproperties](../../components/schema/ref_in_additionalproperties.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_additionalproperties_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_additionalproperties_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..9d37e605e7a --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_allof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_allof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_allof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_allof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_allof_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_allof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInAllofResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInAllofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInAllofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAllof](../../components/schema/ref_in_allof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_allof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_allof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..86077dbf9b9 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_anyof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_anyof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_anyof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_anyof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_anyof_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_anyof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInAnyofResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInAnyofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInAnyofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInAnyof](../../components/schema/ref_in_anyof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_anyof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_anyof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md new file mode 100644 index 00000000000..4ccd96a92ec --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_items_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_items_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_items_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_items_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_items_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_items_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInItemsResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInItemsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInItemsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInItems](../../components/schema/ref_in_items.md) | list, tuple | tuple | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_items_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_items_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md new file mode 100644 index 00000000000..b96b322fb47 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_not_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_not_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_not_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_not_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_not_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_not_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInNotResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInNotResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInNotResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInNot](../../components/schema/ref_in_not.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_not_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_not_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md new file mode 100644 index 00000000000..813b7cbeb1a --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_oneof_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_oneof_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_oneof_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_oneof_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_oneof_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_oneof_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInOneofResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInOneofResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInOneofResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInOneof](../../components/schema/ref_in_oneof.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_oneof_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_oneof_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md new file mode 100644 index 00000000000..58e63f037d2 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_ref_in_property_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_ref_in_property_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_ref_in_property_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_ref_in_property_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_ref_in_property_response_body_for_content_types | [RefApi](../../apis/tags/ref_api.md) | This api is only for tag=$ref | +| post_ref_in_property_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRefInPropertyResponseBodyForContentTypes | This api is only for path=/responseBody/postRefInPropertyResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRefInPropertyResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefInProperty](../../components/schema/ref_in_property.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_ref_in_property_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_ref_in_property_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to RefApi API]](../../apis/tags/ref_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..414a51585ec --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_default_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_required_default_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_default_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_default_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_default_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_required_default_validation_response_body_for_content_types | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRequiredDefaultValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRequiredDefaultValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredDefaultValidation](../../components/schema/required_default_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_required_default_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_required_default_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..2e1f2570120 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_required_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_required_validation_response_body_for_content_types | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRequiredValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postRequiredValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRequiredValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredValidation](../../components/schema/required_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_required_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_required_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md new file mode 100644 index 00000000000..48838db4632 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_empty_array_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_required_with_empty_array_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_with_empty_array_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_with_empty_array_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_with_empty_array_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_required_with_empty_array_response_body_for_content_types | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRequiredWithEmptyArrayResponseBodyForContentTypes | This api is only for path=/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRequiredWithEmptyArrayResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredWithEmptyArray](../../components/schema/required_with_empty_array.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_required_with_empty_array_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_required_with_empty_array_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md new file mode 100644 index 00000000000..8bc90f36229 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_required_with_escaped_characters_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_required_with_escaped_characters_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_required_with_escaped_characters_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_required_with_escaped_characters_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_required_with_escaped_characters_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_required_with_escaped_characters_response_body_for_content_types | [RequiredApi](../../apis/tags/required_api.md) | This api is only for tag=required | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostRequiredWithEscapedCharactersResponseBodyForContentTypes | This api is only for path=/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postRequiredWithEscapedCharactersResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RequiredWithEscapedCharacters](../../components/schema/required_with_escaped_characters.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_required_with_escaped_characters_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_required_with_escaped_characters_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to RequiredApi API]](../../apis/tags/required_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..9fbd22403a2 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_simple_enum_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_simple_enum_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_simple_enum_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_simple_enum_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_simple_enum_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post_simple_enum_validation_response_body_for_content_types | [EnumApi](../../apis/tags/enum_api.md) | This api is only for tag=enum | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostSimpleEnumValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postSimpleEnumValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postSimpleEnumValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[SimpleEnumValidation](../../components/schema/simple_enum_validation.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_simple_enum_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_simple_enum_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to EnumApi API]](../../apis/tags/enum_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md new file mode 100644 index 00000000000..159bfaa2450 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_string_type_matches_strings_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_string_type_matches_strings_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_string_type_matches_strings_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_string_type_matches_strings_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_string_type_matches_strings_response_body_for_content_types | [TypeApi](../../apis/tags/type_api.md) | This api is only for tag=type | +| post_string_type_matches_strings_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostStringTypeMatchesStringsResponseBodyForContentTypes | This api is only for path=/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postStringTypeMatchesStringsResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[StringTypeMatchesStrings](../../components/schema/string_type_matches_strings.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_string_type_matches_strings_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_string_type_matches_strings_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to TypeApi API]](../../apis/tags/type_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md new file mode 100644 index 00000000000..e50bd21a2ec --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes | This api is only for path=/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postTheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissingResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[TheDefaultKeywordDoesNotDoAnythingIfThePropertyIsMissing](../../components/schema/the_default_keyword_does_not_do_anything_if_the_property_is_missing.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import default_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling DefaultApi->post_the_default_keyword_does_not_do_anything_if_the_property_is_missing_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..a6546a17505 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_false_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_uniqueitems_false_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uniqueitems_false_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uniqueitems_false_validation_response_body_for_content_types | [UniqueItemsApi](../../apis/tags/unique_items_api.md) | This api is only for tag=uniqueItems | +| post_uniqueitems_false_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uniqueitems_false_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostUniqueitemsFalseValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postUniqueitemsFalseValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UniqueitemsFalseValidation](../../components/schema/uniqueitems_false_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_uniqueitems_false_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_uniqueitems_false_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to UniqueItemsApi API]](../../apis/tags/unique_items_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md new file mode 100644 index 00000000000..6962b4b981d --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uniqueitems_validation_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_uniqueitems_validation_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uniqueitems_validation_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uniqueitems_validation_response_body_for_content_types | [UniqueItemsApi](../../apis/tags/unique_items_api.md) | This api is only for tag=uniqueItems | +| post_uniqueitems_validation_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uniqueitems_validation_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostUniqueitemsValidationResponseBodyForContentTypes | This api is only for path=/responseBody/postUniqueitemsValidationResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postUniqueitemsValidationResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UniqueitemsValidation](../../components/schema/uniqueitems_validation.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_uniqueitems_validation_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_uniqueitems_validation_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to UniqueItemsApi API]](../../apis/tags/unique_items_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..261e328fbec --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_uri_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_uri_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostUriFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postUriFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postUriFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriFormat](../../components/schema/uri_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_uri_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_uri_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..15532ecc6ef --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_reference_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_uri_reference_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_reference_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_reference_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_reference_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_uri_reference_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostUriReferenceFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postUriReferenceFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postUriReferenceFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriReferenceFormat](../../components/schema/uri_reference_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_uri_reference_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_uri_reference_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md new file mode 100644 index 00000000000..95cb944ccf6 --- /dev/null +++ b/samples/openapi3/client/3_0_3_unit_test/python/docs/paths/response_body_post_uri_template_format_response_body_for_content_types/post.md @@ -0,0 +1,107 @@ +unit_test_api.paths.response_body_post_uri_template_format_response_body_for_content_types.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_uri_template_format_response_body_for_content_types | [PathPostApi](../../apis/tags/path_post_api.md) | This api is only for tag=path.post | +| post_uri_template_format_response_body_for_content_types | [ContentTypeJsonApi](../../apis/tags/content_type_json_api.md) | This api is only for tag=contentType_json | +| post_uri_template_format_response_body_for_content_types | [FormatApi](../../apis/tags/format_api.md) | This api is only for tag=format | +| post_uri_template_format_response_body_for_content_types | [ResponseContentContentTypeSchemaApi](../../apis/tags/response_content_content_type_schema_api.md) | This api is only for tag=response.content.contentType.schema | +| post | ApiForPost | This api is only for this endpoint | +| post | ResponseBodyPostUriTemplateFormatResponseBodyForContentTypes | This api is only for path=/responseBody/postUriTemplateFormatResponseBodyForContentTypes | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/responseBody/postUriTemplateFormatResponseBodyForContentTypes" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[UriTemplateFormat](../../components/schema/uri_template_format.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = https://someserver.com/v1 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import unit_test_api +from unit_test_api.configurations import api_configuration +from unit_test_api.apis.tags import path_post_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with unit_test_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = path_post_api.PathPostApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.post_uri_template_format_response_body_for_content_types() + pprint(api_response) + except unit_test_api.ApiException as e: + print("Exception when calling PathPostApi->post_uri_template_format_response_body_for_content_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PathPostApi API]](../../apis/tags/path_post_api.md) +[[Back to ContentTypeJsonApi API]](../../apis/tags/content_type_json_api.md) +[[Back to FormatApi API]](../../apis/tags/format_api.md) +[[Back to ResponseContentContentTypeSchemaApi API]](../../apis/tags/response_content_content_type_schema_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/.openapi-generator/FILES b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/.openapi-generator/FILES index 7f1683e3f9c..9f71c11afaf 100644 --- a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/.openapi-generator/FILES +++ b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/.openapi-generator/FILES @@ -3,10 +3,10 @@ .travis.yml README.md docs/apis/tags/default_api.md -docs/apis/tags/default_api/post_operators.md docs/components/schema/addition_operator.md docs/components/schema/operator.md docs/components/schema/subtraction_operator.md +docs/paths/operators/post.md docs/servers/server_0.md git_push.sh migration_2_0_0.md diff --git a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/README.md b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/README.md index 429fcf80092..a9a69cb447d 100644 --- a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/README.md +++ b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/README.md @@ -90,7 +90,7 @@ All URIs are relative to the selected server HTTP request | Method | Description ------------ | ------ | ------------- -/operators **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_operators](docs/apis/tags/default_api/post_operators.md) | +/operators **post** | [DefaultApi](docs/apis/tags/default_api.md).[post_operators](docs/paths/operators/post.md) | ## Component Schemas diff --git a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api.md b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api.md index 19e70483db3..a904558e9db 100644 --- a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api.md +++ b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api.md @@ -12,6 +12,6 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**post_operators**](default_api/post_operators.md) | +[**post_operators**](../../paths/operators/post.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api/post_operators.md b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api/post_operators.md deleted file mode 100644 index 42604088bfe..00000000000 --- a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/apis/tags/default_api/post_operators.md +++ /dev/null @@ -1,102 +0,0 @@ - -# **post_operators** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/operators" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Operator](../../../components/schema/operator.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK - -## ResponseFor200 - -### Description -OK - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://localhost:3000 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import this_package -from this_package.configurations import api_configuration -from this_package.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with this_package.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example passing only optional values - body = operator.Operator( - a=3.14, - b=3.14, - operator_id="ADD", - ) - try: - api_response = api_instance.post_operators( - body=body, - ) - pprint(api_response) - except this_package.ApiException as e: - print("Exception when calling DefaultApi->post_operators: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/paths/operators/post.md b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/paths/operators/post.md new file mode 100644 index 00000000000..8f3cc6788e7 --- /dev/null +++ b/samples/openapi3/client/features/nonCompliantUseDiscriminatorIfCompositionFails/python/docs/paths/operators/post.md @@ -0,0 +1,110 @@ +this_package.paths.operators.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| post_operators | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| post | ApiForPost | This api is only for this endpoint | +| post | Operators | This api is only for path=/operators | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/operators" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Operator](../../components/schema/operator.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK + +## ResponseFor200 + +### Description +OK + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://localhost:3000 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import this_package +from this_package.configurations import api_configuration +from this_package.apis.tags import default_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with this_package.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example passing only optional values + body = operator.Operator( + a=3.14, + b=3.14, + operator_id="ADD", + ) + try: + api_response = api_instance.post_operators( + body=body, + ) + pprint(api_response) + except this_package.ApiException as e: + print("Exception when calling DefaultApi->post_operators: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/features/security/python/.openapi-generator/FILES b/samples/openapi3/client/features/security/python/.openapi-generator/FILES index 969ab1f5ae1..bd2a04c0d98 100644 --- a/samples/openapi3/client/features/security/python/.openapi-generator/FILES +++ b/samples/openapi3/client/features/security/python/.openapi-generator/FILES @@ -3,13 +3,13 @@ .travis.yml README.md docs/apis/tags/default_api.md -docs/apis/tags/default_api/path_with_no_explicit_security.md -docs/apis/tags/default_api/path_with_one_explicit_security.md -docs/apis/tags/default_api/path_with_security_from_root.md -docs/apis/tags/default_api/path_with_two_explicit_security.md docs/components/security_schemes/security_scheme_api_key.md docs/components/security_schemes/security_scheme_bearer_test.md docs/components/security_schemes/security_scheme_http_basic_test.md +docs/paths/path_with_no_explicit_security/get.md +docs/paths/path_with_one_explicit_security/get.md +docs/paths/path_with_security_from_root/get.md +docs/paths/path_with_two_explicit_security/get.md docs/servers/server_0.md git_push.sh migration_2_0_0.md diff --git a/samples/openapi3/client/features/security/python/README.md b/samples/openapi3/client/features/security/python/README.md index 4e8bdb41e0d..433c5f8aa33 100644 --- a/samples/openapi3/client/features/security/python/README.md +++ b/samples/openapi3/client/features/security/python/README.md @@ -97,10 +97,10 @@ All URIs are relative to the selected server HTTP request | Method | Description ------------ | ------ | ------------- -/pathWithNoExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_no_explicit_security](docs/apis/tags/default_api/path_with_no_explicit_security.md) | path with no explicit security -/pathWithOneExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_one_explicit_security](docs/apis/tags/default_api/path_with_one_explicit_security.md) | path with one explicit security -/pathWithSecurityFromRoot **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_security_from_root](docs/apis/tags/default_api/path_with_security_from_root.md) | path with security from root -/pathWithTwoExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_two_explicit_security](docs/apis/tags/default_api/path_with_two_explicit_security.md) | path with two explicit security +/pathWithNoExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_no_explicit_security](docs/paths/path_with_no_explicit_security/get.md) | path with no explicit security +/pathWithOneExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_one_explicit_security](docs/paths/path_with_one_explicit_security/get.md) | path with one explicit security +/pathWithSecurityFromRoot **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_security_from_root](docs/paths/path_with_security_from_root/get.md) | path with security from root +/pathWithTwoExplicitSecurity **get** | [DefaultApi](docs/apis/tags/default_api.md).[path_with_two_explicit_security](docs/paths/path_with_two_explicit_security/get.md) | path with two explicit security ## Component SecuritySchemes diff --git a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api.md b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api.md index 36c052671be..69b36c71e96 100644 --- a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api.md +++ b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api.md @@ -12,9 +12,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**path_with_no_explicit_security**](default_api/path_with_no_explicit_security.md) | path with no explicit security -[**path_with_one_explicit_security**](default_api/path_with_one_explicit_security.md) | path with one explicit security -[**path_with_security_from_root**](default_api/path_with_security_from_root.md) | path with security from root -[**path_with_two_explicit_security**](default_api/path_with_two_explicit_security.md) | path with two explicit security +[**path_with_no_explicit_security**](../../paths/path_with_no_explicit_security/get.md) | path with no explicit security +[**path_with_one_explicit_security**](../../paths/path_with_one_explicit_security/get.md) | path with one explicit security +[**path_with_security_from_root**](../../paths/path_with_security_from_root/get.md) | path with security from root +[**path_with_two_explicit_security**](../../paths/path_with_two_explicit_security/get.md) | path with two explicit security [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_no_explicit_security.md b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_no_explicit_security.md deleted file mode 100644 index 260d8515128..00000000000 --- a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_no_explicit_security.md +++ /dev/null @@ -1,81 +0,0 @@ - -# **path_with_no_explicit_security** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | path with no explicit security | -| Path | "/pathWithNoExplicitSecurity" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK - -## ResponseFor200 - -### Description -OK - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://localhost:3000 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import this_package -from this_package.configurations import api_configuration -from this_package.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with this_package.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # path with no explicit security - api_response = api_instance.path_with_no_explicit_security() - pprint(api_response) - except this_package.ApiException as e: - print("Exception when calling DefaultApi->path_with_no_explicit_security: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_one_explicit_security.md b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_one_explicit_security.md deleted file mode 100644 index 9274865fdf7..00000000000 --- a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_one_explicit_security.md +++ /dev/null @@ -1,107 +0,0 @@ - -# **path_with_one_explicit_security** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | path with one explicit security | -| Path | "/pathWithOneExplicitSecurity" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK - -## ResponseFor200 - -### Description -OK - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://localhost:3000 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import this_package -from this_package.configurations import api_configuration -from this_package.apis.tags import default_api -from pprint import pprint -# security_index 0 -from this_package.components.security_schemes import security_scheme_api_key - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with this_package.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # path with one explicit security - api_response = api_instance.path_with_one_explicit_security() - pprint(api_response) - except this_package.ApiException as e: - print("Exception when calling DefaultApi->path_with_one_explicit_security: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_security_from_root.md b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_security_from_root.md deleted file mode 100644 index 1145964f504..00000000000 --- a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_security_from_root.md +++ /dev/null @@ -1,141 +0,0 @@ - -# **path_with_security_from_root** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | path with security from root | -| Path | "/pathWithSecurityFromRoot" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK - -## ResponseFor200 - -### Description -OK - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are the general api securities - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["http_basic_test"](../../../components/security_schemes/security_scheme_http_basic_test.md) []
| -| 2 | no security | -| 3 | ["http_basic_test"](../../../components/security_schemes/security_scheme_http_basic_test.md) []
["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://localhost:3000 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import this_package -from this_package.configurations import api_configuration -from this_package.apis.tags import default_api -from pprint import pprint -# security_index 0 -from this_package.components.security_schemes import security_scheme_api_key -# security_index 1 -from this_package.components.security_schemes import security_scheme_http_basic_test -# security_index 3 -from this_package.components.security_schemes import security_scheme_http_basic_test -from this_package.components.security_schemes import security_scheme_api_key - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( - user_id='someUserIdOrName', - password='somePassword', - ), -} - - -# security_scheme_info for security_index 2 -# no auth required for this security_index -security_scheme_info: api_configuration.SecuritySchemeInfo = {} - - -# security_scheme_info for security_index 3 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( - user_id='someUserIdOrName', - password='somePassword', - ), - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with this_package.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # path with security from root - api_response = api_instance.path_with_security_from_root() - pprint(api_response) - except this_package.ApiException as e: - print("Exception when calling DefaultApi->path_with_security_from_root: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_two_explicit_security.md b/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_two_explicit_security.md deleted file mode 100644 index a959bc157df..00000000000 --- a/samples/openapi3/client/features/security/python/docs/apis/tags/default_api/path_with_two_explicit_security.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **path_with_two_explicit_security** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | path with two explicit security | -| Path | "/pathWithTwoExplicitSecurity" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK - -## ResponseFor200 - -### Description -OK - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["bearer_test"](../../../components/security_schemes/security_scheme_bearer_test.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://localhost:3000 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | - -## Code Sample - -```python -import this_package -from this_package.configurations import api_configuration -from this_package.apis.tags import default_api -from pprint import pprint -# security_index 0 -from this_package.components.security_schemes import security_scheme_api_key -# security_index 1 -from this_package.components.security_schemes import security_scheme_bearer_test - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "bearer_test": security_scheme_bearer_test.BearerTest( - access_token='someAccessToken' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with this_package.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # path with two explicit security - api_response = api_instance.path_with_two_explicit_security() - pprint(api_response) - except this_package.ApiException as e: - print("Exception when calling DefaultApi->path_with_two_explicit_security: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/features/security/python/docs/paths/path_with_no_explicit_security/get.md b/samples/openapi3/client/features/security/python/docs/paths/path_with_no_explicit_security/get.md new file mode 100644 index 00000000000..7aa36d6f02b --- /dev/null +++ b/samples/openapi3/client/features/security/python/docs/paths/path_with_no_explicit_security/get.md @@ -0,0 +1,89 @@ +this_package.paths.path_with_no_explicit_security.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| path_with_no_explicit_security | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| get | ApiForGet | This api is only for this endpoint | +| get | PathWithNoExplicitSecurity | This api is only for path=/pathWithNoExplicitSecurity | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | path with no explicit security | +| Path | "/pathWithNoExplicitSecurity" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK + +## ResponseFor200 + +### Description +OK + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://localhost:3000 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import this_package +from this_package.configurations import api_configuration +from this_package.apis.tags import default_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with this_package.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # path with no explicit security + api_response = api_instance.path_with_no_explicit_security() + pprint(api_response) + except this_package.ApiException as e: + print("Exception when calling DefaultApi->path_with_no_explicit_security: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/features/security/python/docs/paths/path_with_one_explicit_security/get.md b/samples/openapi3/client/features/security/python/docs/paths/path_with_one_explicit_security/get.md new file mode 100644 index 00000000000..fecb2c82d0b --- /dev/null +++ b/samples/openapi3/client/features/security/python/docs/paths/path_with_one_explicit_security/get.md @@ -0,0 +1,115 @@ +this_package.paths.path_with_one_explicit_security.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| path_with_one_explicit_security | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| get | ApiForGet | This api is only for this endpoint | +| get | PathWithOneExplicitSecurity | This api is only for path=/pathWithOneExplicitSecurity | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | path with one explicit security | +| Path | "/pathWithOneExplicitSecurity" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK + +## ResponseFor200 + +### Description +OK + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://localhost:3000 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import this_package +from this_package.configurations import api_configuration +from this_package.apis.tags import default_api +from pprint import pprint +# security_index 0 +from this_package.components.security_schemes import security_scheme_api_key + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with this_package.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # path with one explicit security + api_response = api_instance.path_with_one_explicit_security() + pprint(api_response) + except this_package.ApiException as e: + print("Exception when calling DefaultApi->path_with_one_explicit_security: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/features/security/python/docs/paths/path_with_security_from_root/get.md b/samples/openapi3/client/features/security/python/docs/paths/path_with_security_from_root/get.md new file mode 100644 index 00000000000..c3c32a8a045 --- /dev/null +++ b/samples/openapi3/client/features/security/python/docs/paths/path_with_security_from_root/get.md @@ -0,0 +1,149 @@ +this_package.paths.path_with_security_from_root.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| path_with_security_from_root | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| get | ApiForGet | This api is only for this endpoint | +| get | PathWithSecurityFromRoot | This api is only for path=/pathWithSecurityFromRoot | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | path with security from root | +| Path | "/pathWithSecurityFromRoot" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK + +## ResponseFor200 + +### Description +OK + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are the general api securities + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["http_basic_test"](../../components/security_schemes/security_scheme_http_basic_test.md) []
| +| 2 | no security | +| 3 | ["http_basic_test"](../../components/security_schemes/security_scheme_http_basic_test.md) []
["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://localhost:3000 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import this_package +from this_package.configurations import api_configuration +from this_package.apis.tags import default_api +from pprint import pprint +# security_index 0 +from this_package.components.security_schemes import security_scheme_api_key +# security_index 1 +from this_package.components.security_schemes import security_scheme_http_basic_test +# security_index 3 +from this_package.components.security_schemes import security_scheme_http_basic_test +from this_package.components.security_schemes import security_scheme_api_key + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( + user_id='someUserIdOrName', + password='somePassword', + ), +} + + +# security_scheme_info for security_index 2 +# no auth required for this security_index +security_scheme_info: api_configuration.SecuritySchemeInfo = {} + + +# security_scheme_info for security_index 3 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( + user_id='someUserIdOrName', + password='somePassword', + ), + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with this_package.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # path with security from root + api_response = api_instance.path_with_security_from_root() + pprint(api_response) + except this_package.ApiException as e: + print("Exception when calling DefaultApi->path_with_security_from_root: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/features/security/python/docs/paths/path_with_two_explicit_security/get.md b/samples/openapi3/client/features/security/python/docs/paths/path_with_two_explicit_security/get.md new file mode 100644 index 00000000000..c0a712f2d1b --- /dev/null +++ b/samples/openapi3/client/features/security/python/docs/paths/path_with_two_explicit_security/get.md @@ -0,0 +1,126 @@ +this_package.paths.path_with_two_explicit_security.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| path_with_two_explicit_security | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| get | ApiForGet | This api is only for this endpoint | +| get | PathWithTwoExplicitSecurity | This api is only for path=/pathWithTwoExplicitSecurity | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | path with two explicit security | +| Path | "/pathWithTwoExplicitSecurity" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | OK + +## ResponseFor200 + +### Description +OK + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["bearer_test"](../../components/security_schemes/security_scheme_bearer_test.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://localhost:3000 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | + +## Code Sample + +```python +import this_package +from this_package.configurations import api_configuration +from this_package.apis.tags import default_api +from pprint import pprint +# security_index 0 +from this_package.components.security_schemes import security_scheme_api_key +# security_index 1 +from this_package.components.security_schemes import security_scheme_bearer_test + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "bearer_test": security_scheme_bearer_test.BearerTest( + access_token='someAccessToken' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with this_package.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # path with two explicit security + api_response = api_instance.path_with_two_explicit_security() + pprint(api_response) + except this_package.ApiException as e: + print("Exception when calling DefaultApi->path_with_two_explicit_security: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/.openapi-generator/FILES b/samples/openapi3/client/petstore/python/.openapi-generator/FILES index 53647d5ded3..657621c2ada 100644 --- a/samples/openapi3/client/petstore/python/.openapi-generator/FILES +++ b/samples/openapi3/client/petstore/python/.openapi-generator/FILES @@ -3,71 +3,12 @@ .travis.yml README.md docs/apis/tags/another_fake_api.md -docs/apis/tags/another_fake_api/call_123_test__special_tags.md docs/apis/tags/default_api.md -docs/apis/tags/default_api/foo_get.md docs/apis/tags/fake_api.md -docs/apis/tags/fake_api/additional_properties_with_array_of_enums.md -docs/apis/tags/fake_api/array_model.md -docs/apis/tags/fake_api/array_of_enums.md -docs/apis/tags/fake_api/body_with_file_schema.md -docs/apis/tags/fake_api/body_with_query_params.md -docs/apis/tags/fake_api/boolean.md -docs/apis/tags/fake_api/case_sensitive_params.md -docs/apis/tags/fake_api/client_model.md -docs/apis/tags/fake_api/composed_one_of_different_types.md -docs/apis/tags/fake_api/delete_coffee.md -docs/apis/tags/fake_api/endpoint_parameters.md -docs/apis/tags/fake_api/enum_parameters.md -docs/apis/tags/fake_api/fake_health_get.md -docs/apis/tags/fake_api/group_parameters.md -docs/apis/tags/fake_api/inline_additional_properties.md -docs/apis/tags/fake_api/inline_composition.md -docs/apis/tags/fake_api/json_form_data.md -docs/apis/tags/fake_api/json_patch.md -docs/apis/tags/fake_api/json_with_charset.md -docs/apis/tags/fake_api/mammal.md -docs/apis/tags/fake_api/multiple_response_bodies.md -docs/apis/tags/fake_api/multiple_securities.md -docs/apis/tags/fake_api/number_with_validations.md -docs/apis/tags/fake_api/object_in_query.md -docs/apis/tags/fake_api/object_model_with_ref_props.md -docs/apis/tags/fake_api/parameter_collisions.md -docs/apis/tags/fake_api/query_param_with_json_content_type.md -docs/apis/tags/fake_api/query_parameter_collection_format.md -docs/apis/tags/fake_api/ref_object_in_query.md -docs/apis/tags/fake_api/response_without_schema.md -docs/apis/tags/fake_api/string.md -docs/apis/tags/fake_api/string_enum.md -docs/apis/tags/fake_api/upload_download_file.md -docs/apis/tags/fake_api/upload_file.md -docs/apis/tags/fake_api/upload_files.md docs/apis/tags/fake_classname_tags123_api.md -docs/apis/tags/fake_classname_tags123_api/classname.md docs/apis/tags/pet_api.md -docs/apis/tags/pet_api/add_pet.md -docs/apis/tags/pet_api/delete_pet.md -docs/apis/tags/pet_api/find_pets_by_status.md -docs/apis/tags/pet_api/find_pets_by_tags.md -docs/apis/tags/pet_api/get_pet_by_id.md -docs/apis/tags/pet_api/update_pet.md -docs/apis/tags/pet_api/update_pet_with_form.md -docs/apis/tags/pet_api/upload_file_with_required_file.md -docs/apis/tags/pet_api/upload_image.md docs/apis/tags/store_api.md -docs/apis/tags/store_api/delete_order.md -docs/apis/tags/store_api/get_inventory.md -docs/apis/tags/store_api/get_order_by_id.md -docs/apis/tags/store_api/place_order.md docs/apis/tags/user_api.md -docs/apis/tags/user_api/create_user.md -docs/apis/tags/user_api/create_users_with_array_input.md -docs/apis/tags/user_api/create_users_with_list_input.md -docs/apis/tags/user_api/delete_user.md -docs/apis/tags/user_api/get_user_by_name.md -docs/apis/tags/user_api/login_user.md -docs/apis/tags/user_api/logout_user.md -docs/apis/tags/user_api/update_user.md docs/components/headers/header_int32_json_content_type_header.md docs/components/headers/header_number_header.md docs/components/headers/header_ref_content_schema_header.md @@ -226,6 +167,65 @@ docs/components/security_schemes/security_scheme_http_basic_test.md docs/components/security_schemes/security_scheme_http_signature_test.md docs/components/security_schemes/security_scheme_open_id_connect_test.md docs/components/security_schemes/security_scheme_petstore_auth.md +docs/paths/another_fake_dummy/patch.md +docs/paths/fake/delete.md +docs/paths/fake/get.md +docs/paths/fake/patch.md +docs/paths/fake/post.md +docs/paths/fake_additional_properties_with_array_of_enums/get.md +docs/paths/fake_body_with_file_schema/put.md +docs/paths/fake_body_with_query_params/put.md +docs/paths/fake_case_sensitive_params/put.md +docs/paths/fake_classname_test/patch.md +docs/paths/fake_delete_coffee_id/delete.md +docs/paths/fake_health/get.md +docs/paths/fake_inline_additional_properties/post.md +docs/paths/fake_inline_composition/post.md +docs/paths/fake_json_form_data/get.md +docs/paths/fake_json_patch/patch.md +docs/paths/fake_json_with_charset/post.md +docs/paths/fake_multiple_response_bodies/get.md +docs/paths/fake_multiple_securities/get.md +docs/paths/fake_obj_in_query/get.md +docs/paths/fake_parameter_collisions1_abab_self_ab/post.md +docs/paths/fake_pet_id_upload_image_with_required_file/post.md +docs/paths/fake_query_param_with_json_content_type/get.md +docs/paths/fake_ref_obj_in_query/get.md +docs/paths/fake_refs_array_of_enums/post.md +docs/paths/fake_refs_arraymodel/post.md +docs/paths/fake_refs_boolean/post.md +docs/paths/fake_refs_composed_one_of_number_with_validations/post.md +docs/paths/fake_refs_enum/post.md +docs/paths/fake_refs_mammal/post.md +docs/paths/fake_refs_number/post.md +docs/paths/fake_refs_object_model_with_ref_props/post.md +docs/paths/fake_refs_string/post.md +docs/paths/fake_response_without_schema/get.md +docs/paths/fake_test_query_paramters/put.md +docs/paths/fake_upload_download_file/post.md +docs/paths/fake_upload_file/post.md +docs/paths/fake_upload_files/post.md +docs/paths/foo/get.md +docs/paths/pet/post.md +docs/paths/pet/put.md +docs/paths/pet_find_by_status/get.md +docs/paths/pet_find_by_tags/get.md +docs/paths/pet_pet_id/delete.md +docs/paths/pet_pet_id/get.md +docs/paths/pet_pet_id/post.md +docs/paths/pet_pet_id_upload_image/post.md +docs/paths/store_inventory/get.md +docs/paths/store_order/post.md +docs/paths/store_order_order_id/delete.md +docs/paths/store_order_order_id/get.md +docs/paths/user/post.md +docs/paths/user_create_with_array/post.md +docs/paths/user_create_with_list/post.md +docs/paths/user_login/get.md +docs/paths/user_logout/get.md +docs/paths/user_username/delete.md +docs/paths/user_username/get.md +docs/paths/user_username/put.md docs/servers/server_0.md docs/servers/server_1.md docs/servers/server_2.md diff --git a/samples/openapi3/client/petstore/python/README.md b/samples/openapi3/client/petstore/python/README.md index 9c4736a2b95..5d6084cdee9 100644 --- a/samples/openapi3/client/petstore/python/README.md +++ b/samples/openapi3/client/petstore/python/README.md @@ -91,65 +91,65 @@ All URIs are relative to the selected server HTTP request | Method | Description ------------ | ------ | ------------- -/another-fake/dummy **patch** | [AnotherFakeApi](docs/apis/tags/another_fake_api.md).[call_123_test__special_tags](docs/apis/tags/another_fake_api/call_123_test__special_tags.md) | To test special tags -/fake **delete** | [FakeApi](docs/apis/tags/fake_api.md).[group_parameters](docs/apis/tags/fake_api/group_parameters.md) | Fake endpoint to test group parameters (optional) -/fake **get** | [FakeApi](docs/apis/tags/fake_api.md).[enum_parameters](docs/apis/tags/fake_api/enum_parameters.md) | To test enum parameters -/fake **patch** | [FakeApi](docs/apis/tags/fake_api.md).[client_model](docs/apis/tags/fake_api/client_model.md) | To test \"client\" model -/fake **post** | [FakeApi](docs/apis/tags/fake_api.md).[endpoint_parameters](docs/apis/tags/fake_api/endpoint_parameters.md) | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 -/fake/additional-properties-with-array-of-enums **get** | [FakeApi](docs/apis/tags/fake_api.md).[additional_properties_with_array_of_enums](docs/apis/tags/fake_api/additional_properties_with_array_of_enums.md) | Additional Properties with Array of Enums -/fake/body-with-file-schema **put** | [FakeApi](docs/apis/tags/fake_api.md).[body_with_file_schema](docs/apis/tags/fake_api/body_with_file_schema.md) | -/fake/body-with-query-params **put** | [FakeApi](docs/apis/tags/fake_api.md).[body_with_query_params](docs/apis/tags/fake_api/body_with_query_params.md) | -/fake/case-sensitive-params **put** | [FakeApi](docs/apis/tags/fake_api.md).[case_sensitive_params](docs/apis/tags/fake_api/case_sensitive_params.md) | -/fake/deleteCoffee/{id} **delete** | [FakeApi](docs/apis/tags/fake_api.md).[delete_coffee](docs/apis/tags/fake_api/delete_coffee.md) | Delete coffee -/fake/health **get** | [FakeApi](docs/apis/tags/fake_api.md).[fake_health_get](docs/apis/tags/fake_api/fake_health_get.md) | Health check endpoint -/fake/inline-additionalProperties **post** | [FakeApi](docs/apis/tags/fake_api.md).[inline_additional_properties](docs/apis/tags/fake_api/inline_additional_properties.md) | test inline additionalProperties -/fake/inlineComposition/ **post** | [FakeApi](docs/apis/tags/fake_api.md).[inline_composition](docs/apis/tags/fake_api/inline_composition.md) | testing composed schemas at inline locations -/fake/jsonFormData **get** | [FakeApi](docs/apis/tags/fake_api.md).[json_form_data](docs/apis/tags/fake_api/json_form_data.md) | test json serialization of form data -/fake/jsonPatch **patch** | [FakeApi](docs/apis/tags/fake_api.md).[json_patch](docs/apis/tags/fake_api/json_patch.md) | json patch -/fake/jsonWithCharset **post** | [FakeApi](docs/apis/tags/fake_api.md).[json_with_charset](docs/apis/tags/fake_api/json_with_charset.md) | json with charset tx and rx -/fake/multipleResponseBodies **get** | [FakeApi](docs/apis/tags/fake_api.md).[multiple_response_bodies](docs/apis/tags/fake_api/multiple_response_bodies.md) | multiple responses have response bodies -/fake/multipleSecurities **get** | [FakeApi](docs/apis/tags/fake_api.md).[multiple_securities](docs/apis/tags/fake_api/multiple_securities.md) | multiple security requirements -/fake/objInQuery **get** | [FakeApi](docs/apis/tags/fake_api.md).[object_in_query](docs/apis/tags/fake_api/object_in_query.md) | user list -/fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/ **post** | [FakeApi](docs/apis/tags/fake_api.md).[parameter_collisions](docs/apis/tags/fake_api/parameter_collisions.md) | parameter collision case -/fake/queryParamWithJsonContentType **get** | [FakeApi](docs/apis/tags/fake_api.md).[query_param_with_json_content_type](docs/apis/tags/fake_api/query_param_with_json_content_type.md) | query param with json content-type -/fake/refObjInQuery **get** | [FakeApi](docs/apis/tags/fake_api.md).[ref_object_in_query](docs/apis/tags/fake_api/ref_object_in_query.md) | user list -/fake/refs/array-of-enums **post** | [FakeApi](docs/apis/tags/fake_api.md).[array_of_enums](docs/apis/tags/fake_api/array_of_enums.md) | Array of Enums -/fake/refs/arraymodel **post** | [FakeApi](docs/apis/tags/fake_api.md).[array_model](docs/apis/tags/fake_api/array_model.md) | -/fake/refs/boolean **post** | [FakeApi](docs/apis/tags/fake_api.md).[boolean](docs/apis/tags/fake_api/boolean.md) | -/fake/refs/composed_one_of_number_with_validations **post** | [FakeApi](docs/apis/tags/fake_api.md).[composed_one_of_different_types](docs/apis/tags/fake_api/composed_one_of_different_types.md) | -/fake/refs/enum **post** | [FakeApi](docs/apis/tags/fake_api.md).[string_enum](docs/apis/tags/fake_api/string_enum.md) | -/fake/refs/mammal **post** | [FakeApi](docs/apis/tags/fake_api.md).[mammal](docs/apis/tags/fake_api/mammal.md) | -/fake/refs/number **post** | [FakeApi](docs/apis/tags/fake_api.md).[number_with_validations](docs/apis/tags/fake_api/number_with_validations.md) | -/fake/refs/object_model_with_ref_props **post** | [FakeApi](docs/apis/tags/fake_api.md).[object_model_with_ref_props](docs/apis/tags/fake_api/object_model_with_ref_props.md) | -/fake/refs/string **post** | [FakeApi](docs/apis/tags/fake_api.md).[string](docs/apis/tags/fake_api/string.md) | -/fake/responseWithoutSchema **get** | [FakeApi](docs/apis/tags/fake_api.md).[response_without_schema](docs/apis/tags/fake_api/response_without_schema.md) | receives a response without schema -/fake/test-query-paramters **put** | [FakeApi](docs/apis/tags/fake_api.md).[query_parameter_collection_format](docs/apis/tags/fake_api/query_parameter_collection_format.md) | -/fake/uploadDownloadFile **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_download_file](docs/apis/tags/fake_api/upload_download_file.md) | uploads a file and downloads a file using application/octet-stream -/fake/uploadFile **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_file](docs/apis/tags/fake_api/upload_file.md) | uploads a file using multipart/form-data -/fake/uploadFiles **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_files](docs/apis/tags/fake_api/upload_files.md) | uploads files using multipart/form-data -/fake/{petId}/uploadImageWithRequiredFile **post** | [PetApi](docs/apis/tags/pet_api.md).[upload_file_with_required_file](docs/apis/tags/pet_api/upload_file_with_required_file.md) | uploads an image (required) -/fake_classname_test **patch** | [FakeClassnameTags123Api](docs/apis/tags/fake_classname_tags123_api.md).[classname](docs/apis/tags/fake_classname_tags123_api/classname.md) | To test class name in snake case -/foo **get** | [DefaultApi](docs/apis/tags/default_api.md).[foo_get](docs/apis/tags/default_api/foo_get.md) | -/pet **post** | [PetApi](docs/apis/tags/pet_api.md).[add_pet](docs/apis/tags/pet_api/add_pet.md) | Add a new pet to the store -/pet **put** | [PetApi](docs/apis/tags/pet_api.md).[update_pet](docs/apis/tags/pet_api/update_pet.md) | Update an existing pet -/pet/findByStatus **get** | [PetApi](docs/apis/tags/pet_api.md).[find_pets_by_status](docs/apis/tags/pet_api/find_pets_by_status.md) | Finds Pets by status -/pet/findByTags **get** | [PetApi](docs/apis/tags/pet_api.md).[find_pets_by_tags](docs/apis/tags/pet_api/find_pets_by_tags.md) | Finds Pets by tags -/pet/{petId} **delete** | [PetApi](docs/apis/tags/pet_api.md).[delete_pet](docs/apis/tags/pet_api/delete_pet.md) | Deletes a pet -/pet/{petId} **get** | [PetApi](docs/apis/tags/pet_api.md).[get_pet_by_id](docs/apis/tags/pet_api/get_pet_by_id.md) | Find pet by ID -/pet/{petId} **post** | [PetApi](docs/apis/tags/pet_api.md).[update_pet_with_form](docs/apis/tags/pet_api/update_pet_with_form.md) | Updates a pet in the store with form data -/pet/{petId}/uploadImage **post** | [PetApi](docs/apis/tags/pet_api.md).[upload_image](docs/apis/tags/pet_api/upload_image.md) | uploads an image -/store/inventory **get** | [StoreApi](docs/apis/tags/store_api.md).[get_inventory](docs/apis/tags/store_api/get_inventory.md) | Returns pet inventories by status -/store/order **post** | [StoreApi](docs/apis/tags/store_api.md).[place_order](docs/apis/tags/store_api/place_order.md) | Place an order for a pet -/store/order/{order_id} **delete** | [StoreApi](docs/apis/tags/store_api.md).[delete_order](docs/apis/tags/store_api/delete_order.md) | Delete purchase order by ID -/store/order/{order_id} **get** | [StoreApi](docs/apis/tags/store_api.md).[get_order_by_id](docs/apis/tags/store_api/get_order_by_id.md) | Find purchase order by ID -/user **post** | [UserApi](docs/apis/tags/user_api.md).[create_user](docs/apis/tags/user_api/create_user.md) | Create user -/user/createWithArray **post** | [UserApi](docs/apis/tags/user_api.md).[create_users_with_array_input](docs/apis/tags/user_api/create_users_with_array_input.md) | Creates list of users with given input array -/user/createWithList **post** | [UserApi](docs/apis/tags/user_api.md).[create_users_with_list_input](docs/apis/tags/user_api/create_users_with_list_input.md) | Creates list of users with given input array -/user/login **get** | [UserApi](docs/apis/tags/user_api.md).[login_user](docs/apis/tags/user_api/login_user.md) | Logs user into the system -/user/logout **get** | [UserApi](docs/apis/tags/user_api.md).[logout_user](docs/apis/tags/user_api/logout_user.md) | Logs out current logged in user session -/user/{username} **delete** | [UserApi](docs/apis/tags/user_api.md).[delete_user](docs/apis/tags/user_api/delete_user.md) | Delete user -/user/{username} **get** | [UserApi](docs/apis/tags/user_api.md).[get_user_by_name](docs/apis/tags/user_api/get_user_by_name.md) | Get user by user name -/user/{username} **put** | [UserApi](docs/apis/tags/user_api.md).[update_user](docs/apis/tags/user_api/update_user.md) | Updated user +/another-fake/dummy **patch** | [AnotherFakeApi](docs/apis/tags/another_fake_api.md).[call_123_test__special_tags](docs/paths/another_fake_dummy/patch.md) | To test special tags +/fake **delete** | [FakeApi](docs/apis/tags/fake_api.md).[group_parameters](docs/paths/fake/delete.md) | Fake endpoint to test group parameters (optional) +/fake **get** | [FakeApi](docs/apis/tags/fake_api.md).[enum_parameters](docs/paths/fake/get.md) | To test enum parameters +/fake **patch** | [FakeApi](docs/apis/tags/fake_api.md).[client_model](docs/paths/fake/patch.md) | To test \"client\" model +/fake **post** | [FakeApi](docs/apis/tags/fake_api.md).[endpoint_parameters](docs/paths/fake/post.md) | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +/fake/additional-properties-with-array-of-enums **get** | [FakeApi](docs/apis/tags/fake_api.md).[additional_properties_with_array_of_enums](docs/paths/fake_additional_properties_with_array_of_enums/get.md) | Additional Properties with Array of Enums +/fake/body-with-file-schema **put** | [FakeApi](docs/apis/tags/fake_api.md).[body_with_file_schema](docs/paths/fake_body_with_file_schema/put.md) | +/fake/body-with-query-params **put** | [FakeApi](docs/apis/tags/fake_api.md).[body_with_query_params](docs/paths/fake_body_with_query_params/put.md) | +/fake/case-sensitive-params **put** | [FakeApi](docs/apis/tags/fake_api.md).[case_sensitive_params](docs/paths/fake_case_sensitive_params/put.md) | +/fake/deleteCoffee/{id} **delete** | [FakeApi](docs/apis/tags/fake_api.md).[delete_coffee](docs/paths/fake_delete_coffee_id/delete.md) | Delete coffee +/fake/health **get** | [FakeApi](docs/apis/tags/fake_api.md).[fake_health_get](docs/paths/fake_health/get.md) | Health check endpoint +/fake/inline-additionalProperties **post** | [FakeApi](docs/apis/tags/fake_api.md).[inline_additional_properties](docs/paths/fake_inline_additional_properties/post.md) | test inline additionalProperties +/fake/inlineComposition/ **post** | [FakeApi](docs/apis/tags/fake_api.md).[inline_composition](docs/paths/fake_inline_composition/post.md) | testing composed schemas at inline locations +/fake/jsonFormData **get** | [FakeApi](docs/apis/tags/fake_api.md).[json_form_data](docs/paths/fake_json_form_data/get.md) | test json serialization of form data +/fake/jsonPatch **patch** | [FakeApi](docs/apis/tags/fake_api.md).[json_patch](docs/paths/fake_json_patch/patch.md) | json patch +/fake/jsonWithCharset **post** | [FakeApi](docs/apis/tags/fake_api.md).[json_with_charset](docs/paths/fake_json_with_charset/post.md) | json with charset tx and rx +/fake/multipleResponseBodies **get** | [FakeApi](docs/apis/tags/fake_api.md).[multiple_response_bodies](docs/paths/fake_multiple_response_bodies/get.md) | multiple responses have response bodies +/fake/multipleSecurities **get** | [FakeApi](docs/apis/tags/fake_api.md).[multiple_securities](docs/paths/fake_multiple_securities/get.md) | multiple security requirements +/fake/objInQuery **get** | [FakeApi](docs/apis/tags/fake_api.md).[object_in_query](docs/paths/fake_obj_in_query/get.md) | user list +/fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/ **post** | [FakeApi](docs/apis/tags/fake_api.md).[parameter_collisions](docs/paths/fake_parameter_collisions1_abab_self_ab/post.md) | parameter collision case +/fake/queryParamWithJsonContentType **get** | [FakeApi](docs/apis/tags/fake_api.md).[query_param_with_json_content_type](docs/paths/fake_query_param_with_json_content_type/get.md) | query param with json content-type +/fake/refObjInQuery **get** | [FakeApi](docs/apis/tags/fake_api.md).[ref_object_in_query](docs/paths/fake_ref_obj_in_query/get.md) | user list +/fake/refs/array-of-enums **post** | [FakeApi](docs/apis/tags/fake_api.md).[array_of_enums](docs/paths/fake_refs_array_of_enums/post.md) | Array of Enums +/fake/refs/arraymodel **post** | [FakeApi](docs/apis/tags/fake_api.md).[array_model](docs/paths/fake_refs_arraymodel/post.md) | +/fake/refs/boolean **post** | [FakeApi](docs/apis/tags/fake_api.md).[boolean](docs/paths/fake_refs_boolean/post.md) | +/fake/refs/composed_one_of_number_with_validations **post** | [FakeApi](docs/apis/tags/fake_api.md).[composed_one_of_different_types](docs/paths/fake_refs_composed_one_of_number_with_validations/post.md) | +/fake/refs/enum **post** | [FakeApi](docs/apis/tags/fake_api.md).[string_enum](docs/paths/fake_refs_enum/post.md) | +/fake/refs/mammal **post** | [FakeApi](docs/apis/tags/fake_api.md).[mammal](docs/paths/fake_refs_mammal/post.md) | +/fake/refs/number **post** | [FakeApi](docs/apis/tags/fake_api.md).[number_with_validations](docs/paths/fake_refs_number/post.md) | +/fake/refs/object_model_with_ref_props **post** | [FakeApi](docs/apis/tags/fake_api.md).[object_model_with_ref_props](docs/paths/fake_refs_object_model_with_ref_props/post.md) | +/fake/refs/string **post** | [FakeApi](docs/apis/tags/fake_api.md).[string](docs/paths/fake_refs_string/post.md) | +/fake/responseWithoutSchema **get** | [FakeApi](docs/apis/tags/fake_api.md).[response_without_schema](docs/paths/fake_response_without_schema/get.md) | receives a response without schema +/fake/test-query-paramters **put** | [FakeApi](docs/apis/tags/fake_api.md).[query_parameter_collection_format](docs/paths/fake_test_query_paramters/put.md) | +/fake/uploadDownloadFile **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_download_file](docs/paths/fake_upload_download_file/post.md) | uploads a file and downloads a file using application/octet-stream +/fake/uploadFile **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_file](docs/paths/fake_upload_file/post.md) | uploads a file using multipart/form-data +/fake/uploadFiles **post** | [FakeApi](docs/apis/tags/fake_api.md).[upload_files](docs/paths/fake_upload_files/post.md) | uploads files using multipart/form-data +/fake/{petId}/uploadImageWithRequiredFile **post** | [PetApi](docs/apis/tags/pet_api.md).[upload_file_with_required_file](docs/paths/fake_pet_id_upload_image_with_required_file/post.md) | uploads an image (required) +/fake_classname_test **patch** | [FakeClassnameTags123Api](docs/apis/tags/fake_classname_tags123_api.md).[classname](docs/paths/fake_classname_test/patch.md) | To test class name in snake case +/foo **get** | [DefaultApi](docs/apis/tags/default_api.md).[foo_get](docs/paths/foo/get.md) | +/pet **post** | [PetApi](docs/apis/tags/pet_api.md).[add_pet](docs/paths/pet/post.md) | Add a new pet to the store +/pet **put** | [PetApi](docs/apis/tags/pet_api.md).[update_pet](docs/paths/pet/put.md) | Update an existing pet +/pet/findByStatus **get** | [PetApi](docs/apis/tags/pet_api.md).[find_pets_by_status](docs/paths/pet_find_by_status/get.md) | Finds Pets by status +/pet/findByTags **get** | [PetApi](docs/apis/tags/pet_api.md).[find_pets_by_tags](docs/paths/pet_find_by_tags/get.md) | Finds Pets by tags +/pet/{petId} **delete** | [PetApi](docs/apis/tags/pet_api.md).[delete_pet](docs/paths/pet_pet_id/delete.md) | Deletes a pet +/pet/{petId} **get** | [PetApi](docs/apis/tags/pet_api.md).[get_pet_by_id](docs/paths/pet_pet_id/get.md) | Find pet by ID +/pet/{petId} **post** | [PetApi](docs/apis/tags/pet_api.md).[update_pet_with_form](docs/paths/pet_pet_id/post.md) | Updates a pet in the store with form data +/pet/{petId}/uploadImage **post** | [PetApi](docs/apis/tags/pet_api.md).[upload_image](docs/paths/pet_pet_id_upload_image/post.md) | uploads an image +/store/inventory **get** | [StoreApi](docs/apis/tags/store_api.md).[get_inventory](docs/paths/store_inventory/get.md) | Returns pet inventories by status +/store/order **post** | [StoreApi](docs/apis/tags/store_api.md).[place_order](docs/paths/store_order/post.md) | Place an order for a pet +/store/order/{order_id} **delete** | [StoreApi](docs/apis/tags/store_api.md).[delete_order](docs/paths/store_order_order_id/delete.md) | Delete purchase order by ID +/store/order/{order_id} **get** | [StoreApi](docs/apis/tags/store_api.md).[get_order_by_id](docs/paths/store_order_order_id/get.md) | Find purchase order by ID +/user **post** | [UserApi](docs/apis/tags/user_api.md).[create_user](docs/paths/user/post.md) | Create user +/user/createWithArray **post** | [UserApi](docs/apis/tags/user_api.md).[create_users_with_array_input](docs/paths/user_create_with_array/post.md) | Creates list of users with given input array +/user/createWithList **post** | [UserApi](docs/apis/tags/user_api.md).[create_users_with_list_input](docs/paths/user_create_with_list/post.md) | Creates list of users with given input array +/user/login **get** | [UserApi](docs/apis/tags/user_api.md).[login_user](docs/paths/user_login/get.md) | Logs user into the system +/user/logout **get** | [UserApi](docs/apis/tags/user_api.md).[logout_user](docs/paths/user_logout/get.md) | Logs out current logged in user session +/user/{username} **delete** | [UserApi](docs/apis/tags/user_api.md).[delete_user](docs/paths/user_username/delete.md) | Delete user +/user/{username} **get** | [UserApi](docs/apis/tags/user_api.md).[get_user_by_name](docs/paths/user_username/get.md) | Get user by user name +/user/{username} **put** | [UserApi](docs/apis/tags/user_api.md).[update_user](docs/paths/user_username/put.md) | Updated user ## Component Schemas diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api.md index afa7b4edad2..d08e53b4b38 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api.md @@ -9,6 +9,6 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**call_123_test__special_tags**](another_fake_api/call_123_test__special_tags.md) | To test special tags +[**call_123_test__special_tags**](../../paths/another_fake_dummy/patch.md) | To test special tags [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api/call_123_test__special_tags.md b/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api/call_123_test__special_tags.md deleted file mode 100644 index d245c8b1dba..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/another_fake_api/call_123_test__special_tags.md +++ /dev/null @@ -1,105 +0,0 @@ - -# **call_123_test__special_tags** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | To test special tags | -| Description | To test special tags and operation ID starting with number | -| Path | "/another-fake/dummy" | -| HTTP Method | patch | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Client](../../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import another_fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = another_fake_api.AnotherFakeApi(api_client) - - # example passing only required values which don't have defaults set - body = client.Client( - client="client_example", - ) - try: - # To test special tags - api_response = api_instance.call_123_test__special_tags( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling AnotherFakeApi->call_123_test__special_tags: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../another_fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/default_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/default_api.md index 393d0893254..f5cff3da626 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/default_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/default_api.md @@ -12,6 +12,6 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**foo_get**](default_api/foo_get.md) | +[**foo_get**](../../paths/foo/get.md) | [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/default_api/foo_get.md b/samples/openapi3/client/petstore/python/docs/apis/tags/default_api/foo_get.md deleted file mode 100644 index 85e2555c596..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/default_api/foo_get.md +++ /dev/null @@ -1,115 +0,0 @@ - -# **foo_get** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/foo" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [Default.response_cls](#default-response_cls) | response - -## Default - -### Description -response - -### Default response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#default-body) | [content.application_json.schema](#default-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### Default Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#default-content-applicationjson-schema) - -### Body Details -#### Default content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**string** | [**Foo**](../../../components/schema/foo.md), dict, frozendict.frozendict | [**Foo**](../../../components/schema/foo.md) | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are specific to this endpoint -- defaults to server_index=0, server.url = https://path-server-test.petstore.local/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](#server0) | -1 | [Server1](#server1) | - -### Server0 - -#### Url -https://path-server-test.petstore.local/v2 - -### Server1 - -#### Url -https://petstore.swagger.io/{version} - -#### Variables -Key | Type | Description | Notes ---- | ---- | ----------- | ------ -**version** | str | | must be one of ["v1", "v2"] if omitted the client will use the default value of v1 - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import default_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = default_api.DefaultApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - api_response = api_instance.foo_get() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling DefaultApi->foo_get: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../default_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api.md index b6691fcc678..48920a07cb5 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api.md @@ -9,40 +9,40 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**additional_properties_with_array_of_enums**](fake_api/additional_properties_with_array_of_enums.md) | Additional Properties with Array of Enums -[**array_model**](fake_api/array_model.md) | -[**array_of_enums**](fake_api/array_of_enums.md) | Array of Enums -[**body_with_file_schema**](fake_api/body_with_file_schema.md) | -[**body_with_query_params**](fake_api/body_with_query_params.md) | -[**boolean**](fake_api/boolean.md) | -[**case_sensitive_params**](fake_api/case_sensitive_params.md) | -[**client_model**](fake_api/client_model.md) | To test \"client\" model -[**composed_one_of_different_types**](fake_api/composed_one_of_different_types.md) | -[**delete_coffee**](fake_api/delete_coffee.md) | Delete coffee -[**endpoint_parameters**](fake_api/endpoint_parameters.md) | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 -[**enum_parameters**](fake_api/enum_parameters.md) | To test enum parameters -[**fake_health_get**](fake_api/fake_health_get.md) | Health check endpoint -[**group_parameters**](fake_api/group_parameters.md) | Fake endpoint to test group parameters (optional) -[**inline_additional_properties**](fake_api/inline_additional_properties.md) | test inline additionalProperties -[**inline_composition**](fake_api/inline_composition.md) | testing composed schemas at inline locations -[**json_form_data**](fake_api/json_form_data.md) | test json serialization of form data -[**json_patch**](fake_api/json_patch.md) | json patch -[**json_with_charset**](fake_api/json_with_charset.md) | json with charset tx and rx -[**mammal**](fake_api/mammal.md) | -[**multiple_response_bodies**](fake_api/multiple_response_bodies.md) | multiple responses have response bodies -[**multiple_securities**](fake_api/multiple_securities.md) | multiple security requirements -[**number_with_validations**](fake_api/number_with_validations.md) | -[**object_in_query**](fake_api/object_in_query.md) | user list -[**object_model_with_ref_props**](fake_api/object_model_with_ref_props.md) | -[**parameter_collisions**](fake_api/parameter_collisions.md) | parameter collision case -[**query_param_with_json_content_type**](fake_api/query_param_with_json_content_type.md) | query param with json content-type -[**query_parameter_collection_format**](fake_api/query_parameter_collection_format.md) | -[**ref_object_in_query**](fake_api/ref_object_in_query.md) | user list -[**response_without_schema**](fake_api/response_without_schema.md) | receives a response without schema -[**string**](fake_api/string.md) | -[**string_enum**](fake_api/string_enum.md) | -[**upload_download_file**](fake_api/upload_download_file.md) | uploads a file and downloads a file using application/octet-stream -[**upload_file**](fake_api/upload_file.md) | uploads a file using multipart/form-data -[**upload_files**](fake_api/upload_files.md) | uploads files using multipart/form-data +[**additional_properties_with_array_of_enums**](../../paths/fake_additional_properties_with_array_of_enums/get.md) | Additional Properties with Array of Enums +[**array_model**](../../paths/fake_refs_arraymodel/post.md) | +[**array_of_enums**](../../paths/fake_refs_array_of_enums/post.md) | Array of Enums +[**body_with_file_schema**](../../paths/fake_body_with_file_schema/put.md) | +[**body_with_query_params**](../../paths/fake_body_with_query_params/put.md) | +[**boolean**](../../paths/fake_refs_boolean/post.md) | +[**case_sensitive_params**](../../paths/fake_case_sensitive_params/put.md) | +[**client_model**](../../paths/fake/patch.md) | To test \"client\" model +[**composed_one_of_different_types**](../../paths/fake_refs_composed_one_of_number_with_validations/post.md) | +[**delete_coffee**](../../paths/fake_delete_coffee_id/delete.md) | Delete coffee +[**endpoint_parameters**](../../paths/fake/post.md) | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +[**enum_parameters**](../../paths/fake/get.md) | To test enum parameters +[**fake_health_get**](../../paths/fake_health/get.md) | Health check endpoint +[**group_parameters**](../../paths/fake/delete.md) | Fake endpoint to test group parameters (optional) +[**inline_additional_properties**](../../paths/fake_inline_additional_properties/post.md) | test inline additionalProperties +[**inline_composition**](../../paths/fake_inline_composition/post.md) | testing composed schemas at inline locations +[**json_form_data**](../../paths/fake_json_form_data/get.md) | test json serialization of form data +[**json_patch**](../../paths/fake_json_patch/patch.md) | json patch +[**json_with_charset**](../../paths/fake_json_with_charset/post.md) | json with charset tx and rx +[**mammal**](../../paths/fake_refs_mammal/post.md) | +[**multiple_response_bodies**](../../paths/fake_multiple_response_bodies/get.md) | multiple responses have response bodies +[**multiple_securities**](../../paths/fake_multiple_securities/get.md) | multiple security requirements +[**number_with_validations**](../../paths/fake_refs_number/post.md) | +[**object_in_query**](../../paths/fake_obj_in_query/get.md) | user list +[**object_model_with_ref_props**](../../paths/fake_refs_object_model_with_ref_props/post.md) | +[**parameter_collisions**](../../paths/fake_parameter_collisions1_abab_self_ab/post.md) | parameter collision case +[**query_param_with_json_content_type**](../../paths/fake_query_param_with_json_content_type/get.md) | query param with json content-type +[**query_parameter_collection_format**](../../paths/fake_test_query_paramters/put.md) | +[**ref_object_in_query**](../../paths/fake_ref_obj_in_query/get.md) | user list +[**response_without_schema**](../../paths/fake_response_without_schema/get.md) | receives a response without schema +[**string**](../../paths/fake_refs_string/post.md) | +[**string_enum**](../../paths/fake_refs_enum/post.md) | +[**upload_download_file**](../../paths/fake_upload_download_file/post.md) | uploads a file and downloads a file using application/octet-stream +[**upload_file**](../../paths/fake_upload_file/post.md) | uploads a file using multipart/form-data +[**upload_files**](../../paths/fake_upload_files/post.md) | uploads files using multipart/form-data [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/additional_properties_with_array_of_enums.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/additional_properties_with_array_of_enums.md deleted file mode 100644 index 8474e7b1217..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/additional_properties_with_array_of_enums.md +++ /dev/null @@ -1,123 +0,0 @@ - -# **additional_properties_with_array_of_enums** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Additional Properties with Array of Enums | -| Path | "/fake/additional-properties-with-array-of-enums" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input enum - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalPropertiesWithArrayOfEnums](../../../components/schema/additional_properties_with_array_of_enums.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Got object with additional properties with array of enums - -## ResponseFor200 - -### Description -Got object with additional properties with array of enums - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AdditionalPropertiesWithArrayOfEnums](../../../components/schema/additional_properties_with_array_of_enums.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = additional_properties_with_array_of_enums.AdditionalPropertiesWithArrayOfEnums( - key=[ - enum_class.EnumClass("-efg") - ], - ) - try: - # Additional Properties with Array of Enums - api_response = api_instance.additional_properties_with_array_of_enums( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->additional_properties_with_array_of_enums: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_model.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_model.md deleted file mode 100644 index 32168be23cb..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_model.md +++ /dev/null @@ -1,120 +0,0 @@ - -# **array_model** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of ArrayModel | -| Path | "/fake/refs/arraymodel" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, list, tuple] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input model - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnimalFarm](../../../components/schema/animal_farm.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model - -## ResponseFor200 - -### Description -Output model - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[AnimalFarm](../../../components/schema/animal_farm.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = animal_farm.AnimalFarm([ - animal.Animal() - ]) - try: - api_response = api_instance.array_model( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->array_model: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_of_enums.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_of_enums.md deleted file mode 100644 index 14113a2623d..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/array_of_enums.md +++ /dev/null @@ -1,121 +0,0 @@ - -# **array_of_enums** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Array of Enums | -| Path | "/fake/refs/array-of-enums" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, list, tuple] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input enum - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayOfEnums](../../../components/schema/array_of_enums.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Got named array of enums - -## ResponseFor200 - -### Description -Got named array of enums - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ArrayOfEnums](../../../components/schema/array_of_enums.md) | list, tuple | tuple | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = array_of_enums.ArrayOfEnums([ - string_enum.StringEnum("string_example") - ]) - try: - # Array of Enums - api_response = api_instance.array_of_enums( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->array_of_enums: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_file_schema.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_file_schema.md deleted file mode 100644 index 3ab0bd62d07..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_file_schema.md +++ /dev/null @@ -1,96 +0,0 @@ - -# **body_with_file_schema** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | For this test, the body for this request much reference a schema named `File`. | -| Path | "/fake/body-with-file-schema" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[FileSchemaTestClass](../../../components/schema/file_schema_test_class.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - body = file_schema_test_class.FileSchemaTestClass( - file=file.File( - source_uri="source_uri_example", - ), - files=[ - file.File() - ], - ) - try: - api_response = api_instance.body_with_file_schema( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->body_with_file_schema: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_query_params.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_query_params.md deleted file mode 100644 index ed03f9b6260..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/body_with_query_params.md +++ /dev/null @@ -1,125 +0,0 @@ - -# **body_with_query_params** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Path | "/fake/body-with-query-params" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[User](../../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -query | [Parameter0.schema](#parameter0-schema), str | | - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'query': "query_example", - } - body = user.User( - id=1, - username="username_example", - first_name="first_name_example", - last_name="last_name_example", - email="email_example", - password="password_example", - phone="phone_example", - user_status=1, - object_with_no_declared_props=dict(), - object_with_no_declared_props_nullable=dict(), - any_type_prop=None, - any_type_except_null_prop=None, - any_type_prop_nullable=None, - ) - try: - api_response = api_instance.body_with_query_params( - query_params=query_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->body_with_query_params: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/boolean.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/boolean.md deleted file mode 100644 index 9c9310cd68d..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/boolean.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **boolean** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of outer boolean types | -| Path | "/fake/refs/boolean" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, bool] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input boolean as post body - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Boolean](../../../components/schema/boolean.md) | bool | BoolClass | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output boolean - -## ResponseFor200 - -### Description -Output boolean - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Boolean](../../../components/schema/boolean.md) | bool | BoolClass | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = boolean.Boolean(True) - try: - api_response = api_instance.boolean( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->boolean: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/case_sensitive_params.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/case_sensitive_params.md deleted file mode 100644 index 6d029617fd6..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/case_sensitive_params.md +++ /dev/null @@ -1,116 +0,0 @@ - -# **case_sensitive_params** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Ensures that original naming is used in endpoint params, that way we on't have collisions | -| Path | "/fake/case-sensitive-params" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -someVar | [Parameter0.schema](#parameter0-schema), str | | -SomeVar | [Parameter1.schema](#parameter1-schema), str | | -some_var | [Parameter2.schema](#parameter2-schema), str | | - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter1 - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter2 - -##### Parameter2 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'someVar': "someVar_example", - 'SomeVar': "SomeVar_example", - 'some_var': "some_var_example", - } - try: - api_response = api_instance.case_sensitive_params( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->case_sensitive_params: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/client_model.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/client_model.md deleted file mode 100644 index ad9ecf5b88a..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/client_model.md +++ /dev/null @@ -1,105 +0,0 @@ - -# **client_model** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | To test \"client\" model | -| Description | To test \"client\" model | -| Path | "/fake" | -| HTTP Method | patch | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Client](../../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - body = client.Client( - client="client_example", - ) - try: - # To test \"client\" model - api_response = api_instance.client_model( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->client_model: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/composed_one_of_different_types.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/composed_one_of_different_types.md deleted file mode 100644 index e7de50b48a4..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/composed_one_of_different_types.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **composed_one_of_different_types** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of object with $refed properties | -| Path | "/fake/refs/composed_one_of_number_with_validations" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input model - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ComposedOneOfDifferentTypes](../../../components/schema/composed_one_of_different_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model - -## ResponseFor200 - -### Description -Output model - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ComposedOneOfDifferentTypes](../../../components/schema/composed_one_of_different_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = composed_one_of_different_types.ComposedOneOfDifferentTypes(None) - try: - api_response = api_instance.composed_one_of_different_types( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->composed_one_of_different_types: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/delete_coffee.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/delete_coffee.md deleted file mode 100644 index 00e8a75bcfb..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/delete_coffee.md +++ /dev/null @@ -1,112 +0,0 @@ - -# **delete_coffee** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Delete coffee | -| Description | Delete the coffee identified by the given id, (delete without request body) | -| Path | "/fake/deleteCoffee/{id}" | -| HTTP Method | delete | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -id | [Parameter0.schema](#parameter0-schema), str | | - - -#### Parameter0 - -##### Description -The internal object id - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [Default.response_cls](#default-response_cls) | Unexpected error -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Default - -### Description -Unexpected error - -### Default response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'id': "id_example", - } - try: - # Delete coffee - api_response = api_instance.delete_coffee( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->delete_coffee: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/endpoint_parameters.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/endpoint_parameters.md deleted file mode 100644 index e266f567292..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/endpoint_parameters.md +++ /dev/null @@ -1,165 +0,0 @@ - -# **endpoint_parameters** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | -| Description | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | -| Path | "/fake" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) - -#### RequestBody content ApplicationXWwwFormUrlencoded Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**byte** | str | str | None | -**double** | decimal.Decimal, int, float | decimal.Decimal | None | value must be a 64 bit float -**number** | decimal.Decimal, int, float | decimal.Decimal | None | -**pattern_without_delimiter** | str | str | None | -**integer** | decimal.Decimal, int | decimal.Decimal | None | [optional] -**int32** | decimal.Decimal, int | decimal.Decimal | None | [optional] value must be a 32 bit integer -**int64** | decimal.Decimal, int | decimal.Decimal | None | [optional] value must be a 64 bit integer -**float** | decimal.Decimal, int, float | decimal.Decimal | None | [optional] value must be a 32 bit float -**string** | str | str | None | [optional] -**binary** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | None | [optional] -**date** | str, datetime.date | str | None | [optional] value must conform to RFC-3339 full-date YYYY-MM-DD -**dateTime** | str, datetime.datetime | str | None | [optional] if omitted the server will use the default value of 2010-02-01T10:20:10.111110+01:00 value must conform to RFC-3339 date-time -**password** | str | str | None | [optional] -**callback** | str | str | None | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found - -## ResponseFor404 - -### Description -User not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["http_basic_test"](../../../components/security_schemes/security_scheme_http_basic_test.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_http_basic_test - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( - user_id='someUserIdOrName', - password='somePassword', - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = dict( - integer=10, - int32=20, - int64=1, - number=32.1, - _float=3.14, - double=67.8, - string="A", - pattern_without_delimiter="AUR,rZ#UM/?R,Fp^l6$ARjbhJk C>", - byte='YQ==', - binary=open('/path/to/file', 'rb'), - date="1970-01-01", - date_time="2020-02-02T20:20:20.222220Z", - password="password_example", - callback="callback_example", - ) - try: - # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 - api_response = api_instance.endpoint_parameters( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->endpoint_parameters: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/enum_parameters.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/enum_parameters.md deleted file mode 100644 index 108b4b9e8c6..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/enum_parameters.md +++ /dev/null @@ -1,267 +0,0 @@ - -# **enum_parameters** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | To test enum parameters | -| Description | To test enum parameters | -| Path | "/fake" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | -content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) - -#### RequestBody content ApplicationXWwwFormUrlencoded Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**enum_form_string_array** | list, tuple | [properties.EnumFormStringArray](#requestbody-content-applicationxwwwformurlencoded-schema-properties-enumformstringarray) | Form parameter enum test (string array) | [optional] -**enum_form_string** | str | str | Form parameter enum test (string) | [optional] must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -#### RequestBody content ApplicationXWwwFormUrlencoded Schema properties EnumFormStringArray - -##### Description -Form parameter enum test (string array) - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | Form parameter enum test (string array) | - -##### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -enum_query_string_array | [Parameter2.schema](#parameter2-schema), list, tuple | | optional -enum_query_string | [Parameter3.schema](#parameter3-schema), str | | optional -enum_query_integer | [Parameter4.schema](#parameter4-schema), decimal.Decimal, int | | optional -enum_query_double | [Parameter5.schema](#parameter5-schema), decimal.Decimal, int, float | | optional - - -#### Parameter2 - -##### Description -Query parameter enum test (string array) - -##### Parameter2 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ - -#### Parameter3 - -##### Description -Query parameter enum test (string) - -##### Parameter3 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg - -#### Parameter4 - -##### Description -Query parameter enum test (double) - -##### Parameter4 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | must be one of [1, -2] value must be a 32 bit integer - -#### Parameter5 - -##### Description -Query parameter enum test (double) - -##### Parameter5 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int, float | decimal.Decimal | | must be one of [1.1, -1.2] value must be a 64 bit float - -### header_params -#### RequestHeaderParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -enum_header_string_array | [Parameter0.schema](#parameter0-schema), list, tuple | | optional -enum_header_string | [Parameter1.schema](#parameter1-schema), str | | optional - - -#### Parameter0 - -##### Description -Header parameter enum test (string array) - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ - -#### Parameter1 - -##### Description -Header parameter enum test (string) - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Not found - -## ResponseFor404 - -### Description -Not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor404-body) | [content.application_json.schema](#responsefor404-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor404 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor404-content-applicationjson-schema) - -### Body Details -#### ResponseFor404 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - query_params = { - 'enum_query_string_array': [ - "$" - ], - 'enum_query_string': "-efg", - 'enum_query_integer': 1, - 'enum_query_double': 1.1, - } - header_params = { - 'enum_header_string_array': [ - "$" - ], - 'enum_header_string': "-efg", - } - body = dict( - enum_form_string_array=[ - "$" - ], - enum_form_string="-efg", - ) - try: - # To test enum parameters - api_response = api_instance.enum_parameters( - query_params=query_params, - header_params=header_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->enum_parameters: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/fake_health_get.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/fake_health_get.md deleted file mode 100644 index 098301f23fa..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/fake_health_get.md +++ /dev/null @@ -1,97 +0,0 @@ - -# **fake_health_get** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Health check endpoint | -| Path | "/fake/health" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | The instance started successfully - -## ResponseFor200 - -### Description -The instance started successfully - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[HealthCheckResult](../../../components/schema/health_check_result.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Health check endpoint - api_response = api_instance.fake_health_get() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->fake_health_get: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/group_parameters.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/group_parameters.md deleted file mode 100644 index cf738f57a13..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/group_parameters.md +++ /dev/null @@ -1,225 +0,0 @@ - -# **group_parameters** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Fake endpoint to test group parameters (optional) | -| Description | Fake endpoint to test group parameters (optional) | -| Path | "/fake" | -| HTTP Method | delete | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -required_string_group | [Parameter0.schema](#parameter0-schema), str | | -required_int64_group | [Parameter2.schema](#parameter2-schema), decimal.Decimal, int | | -string_group | [Parameter3.schema](#parameter3-schema), str | | optional -int64_group | [Parameter5.schema](#parameter5-schema), decimal.Decimal, int | | optional - - -#### Parameter0 - -##### Description -Required String in group parameters - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter2 - -##### Description -Required Integer in group parameters - -##### Parameter2 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -#### Parameter3 - -##### Description -String in group parameters - -##### Parameter3 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter5 - -##### Description -Integer in group parameters - -##### Parameter5 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -### header_params -#### RequestHeaderParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -required_boolean_group | [Parameter1.schema](#parameter1-schema), str | | -boolean_group | [Parameter4.schema](#parameter4-schema), str | | optional - - -#### Parameter1 - -##### Description -Required Boolean in group parameters - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | must be one of ["true", "false"] - -#### Parameter4 - -##### Description -Boolean in group parameters - -##### Parameter4 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | must be one of ["true", "false"] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["bearer_test"](../../../components/security_schemes/security_scheme_bearer_test.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_bearer_test - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "bearer_test": security_scheme_bearer_test.BearerTest( - access_token='someAccessToken' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'required_string_group': "required_string_group_example", - 'required_int64_group': 1, - } - header_params = { - 'required_boolean_group': "true", - } - try: - # Fake endpoint to test group parameters (optional) - api_response = api_instance.group_parameters( - query_params=query_params, - header_params=header_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->group_parameters: %s\n" % e) - - # example passing only optional values - query_params = { - 'required_string_group': "required_string_group_example", - 'required_int64_group': 1, - 'string_group': "string_group_example", - 'int64_group': 1, - } - header_params = { - 'required_boolean_group': "true", - 'boolean_group': "true", - } - try: - # Fake endpoint to test group parameters (optional) - api_response = api_instance.group_parameters( - query_params=query_params, - header_params=header_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->group_parameters: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_additional_properties.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_additional_properties.md deleted file mode 100644 index a7970474024..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_additional_properties.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **inline_additional_properties** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | test inline additionalProperties | -| Path | "/fake/inline-additionalProperties" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -request body - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**any_string_name** | str | str | any string name can be used but the value must be the correct type | [optional] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - body = dict( - "key": "key_example", - ) - try: - # test inline additionalProperties - api_response = api_instance.inline_additional_properties( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->inline_additional_properties: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_composition.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_composition.md deleted file mode 100644 index baeab948094..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/inline_composition.md +++ /dev/null @@ -1,287 +0,0 @@ - -# **inline_composition** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | testing composed schemas at inline locations | -| Description | composed schemas at inline locations + multiple requestBody content types | -| Path | "/fake/inlineComposition/" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), [RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", "multipart/form-data", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -multiple content types - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) -"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -##### Composed Schemas (allOf/anyOf/oneOf/not) -##### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#requestbody-content-applicationjson-schema-allof-_0) | str | str | | - -#### RequestBody content ApplicationJson Schema allof _0 - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | -#### RequestBody content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#requestbody-content-multipartformdata-schema-properties-someprop) | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -#### RequestBody content MultipartFormData Schema properties SomeProp - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -##### Composed Schemas (allOf/anyOf/oneOf/not) -##### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#requestbody-content-multipartformdata-schema-properties-someprop-allof-_0) | str | str | | - -#### RequestBody content MultipartFormData Schema properties SomeProp allof _0 - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -compositionAtRoot | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | optional -compositionInProperty | [Parameter1.schema](#parameter1-schema), dict, frozendict.frozendict | | optional - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -###### Composed Schemas (allOf/anyOf/oneOf/not) -###### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#parameter0-schema-allof-_0) | str | str | | - -##### Parameter0 Schema allof _0 - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter1 - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -###### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#parameter1-schema-properties-someprop) | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -##### Parameter1 Schema properties SomeProp - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -###### Composed Schemas (allOf/anyOf/oneOf/not) -###### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#parameter1-schema-properties-someprop-allof-_0) | str | str | | - -##### Parameter1 Schema properties SomeProp allof _0 - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success, multiple content types - -## ResponseFor200 - -### Description -success, multiple content types - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_json.schema](#responsefor200-content-applicationjson-schema), [content.multipart_form_data.schema](#responsefor200-content-multipartformdata-schema)] | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) -"multipart/form-data" | [content.multipart_form_data.Schema](#responsefor200-content-multipartformdata-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -##### Composed Schemas (allOf/anyOf/oneOf/not) -##### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#responsefor200-content-applicationjson-schema-allof-_0) | str | str | | - -#### ResponseFor200 content ApplicationJson Schema allof _0 - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | -#### ResponseFor200 content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#responsefor200-content-multipartformdata-schema-properties-someprop) | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -#### ResponseFor200 content MultipartFormData Schema properties SomeProp - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -##### Composed Schemas (allOf/anyOf/oneOf/not) -##### allOf -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -[_0](#responsefor200-content-multipartformdata-schema-properties-someprop-allof-_0) | str | str | | - -#### ResponseFor200 content MultipartFormData Schema properties SomeProp allof _0 - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - query_params = { - 'compositionAtRoot': None, - 'compositionInProperty': dict( - some_prop=None, - ), - } - body = None - try: - # testing composed schemas at inline locations - api_response = api_instance.inline_composition( - query_params=query_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->inline_composition: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_form_data.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_form_data.md deleted file mode 100644 index b3df168c851..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_form_data.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **json_form_data** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | test json serialization of form data | -| Path | "/fake/jsonFormData" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) - -#### RequestBody content ApplicationXWwwFormUrlencoded Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**param** | str | str | field1 | -**param2** | str | str | field2 | -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = dict( - param="param_example", - param2="param2_example", - ) - try: - # test json serialization of form data - api_response = api_instance.json_form_data( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->json_form_data: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_patch.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_patch.md deleted file mode 100644 index c6d18fa422e..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_patch.md +++ /dev/null @@ -1,93 +0,0 @@ - -# **json_patch** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | json patch | -| Description | json patch route with a requestBody | -| Path | "/fake/jsonPatch" | -| HTTP Method | patch | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json_patchjson.schema](#RequestBody-content-applicationjsonpatchjson-schema), Unset, list, tuple] | optional, default is unset | -content_type | str | optional, default is 'application/json-patch+json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json-patch+json" | [content.application_json_patchjson.Schema](#requestbody-content-applicationjsonpatchjson-schema) - -#### RequestBody content ApplicationJsonPatchjson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[JSONPatchRequest](../../../components/schema/json_patch_request.md) | list, tuple | tuple | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = json_patch_request.JSONPatchRequest([ - None - ]) - try: - # json patch - api_response = api_instance.json_patch( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->json_patch: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_with_charset.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_with_charset.md deleted file mode 100644 index f1429a8cd0e..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/json_with_charset.md +++ /dev/null @@ -1,116 +0,0 @@ - -# **json_with_charset** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | json with charset tx and rx | -| Path | "/fake/jsonWithCharset" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json_charsetutf8.schema](#RequestBody-content-applicationjsoncharsetutf8-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | -content_type | str | optional, default is 'application/json; charset=utf-8' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json; charset=utf-8", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json; charset=utf-8" | [content.application_json_charsetutf8.Schema](#requestbody-content-applicationjsoncharsetutf8-schema) - -#### RequestBody content ApplicationJsonCharsetutf8 Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json_charsetutf8.schema](#responsefor200-content-applicationjsoncharsetutf8-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json; charset=utf-8" | [content.application_json_charsetutf8.Schema](#responsefor200-content-applicationjsoncharsetutf8-schema) - -### Body Details -#### ResponseFor200 content ApplicationJsonCharsetutf8 Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = None - try: - # json with charset tx and rx - api_response = api_instance.json_with_charset( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->json_with_charset: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/mammal.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/mammal.md deleted file mode 100644 index e9b215f1c3b..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/mammal.md +++ /dev/null @@ -1,122 +0,0 @@ - -# **mammal** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of mammals | -| Path | "/fake/refs/mammal" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[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 | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input mammal - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Mammal](../../../components/schema/mammal.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output mammal - -## ResponseFor200 - -### Description -Output mammal - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Mammal](../../../components/schema/mammal.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - body = mammal.Mammal( - has_baleen=True, - has_teeth=True, - class_name="whale", - ) - try: - api_response = api_instance.mammal( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->mammal: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_response_bodies.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_response_bodies.md deleted file mode 100644 index 8895e76d4a8..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_response_bodies.md +++ /dev/null @@ -1,123 +0,0 @@ - -# **multiple_response_bodies** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | multiple responses have response bodies | -| Path | "/fake/multipleResponseBodies" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success -202 | [ResponseFor202.response_cls](#responsefor202-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## ResponseFor202 - -### Description -success - -### ResponseFor202 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor202-body) | [content.application_json.schema](#responsefor202-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor202 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor202-content-applicationjson-schema) - -### Body Details -#### ResponseFor202 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # multiple responses have response bodies - api_response = api_instance.multiple_response_bodies() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->multiple_response_bodies: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_securities.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_securities.md deleted file mode 100644 index 011050238b8..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/multiple_securities.md +++ /dev/null @@ -1,144 +0,0 @@ - -# **multiple_securities** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | multiple security requirements | -| Path | "/fake/multipleSecurities" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | no security | -| 1 | ["http_basic_test"](../../../components/security_schemes/security_scheme_http_basic_test.md) []
["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 2 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_http_basic_test -from petstore_api.components.security_schemes import security_scheme_api_key -# security_index 2 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -# no auth required for this security_index -security_scheme_info: api_configuration.SecuritySchemeInfo = {} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( - user_id='someUserIdOrName', - password='somePassword', - ), - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 2 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # multiple security requirements - api_response = api_instance.multiple_securities() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->multiple_securities: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/number_with_validations.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/number_with_validations.md deleted file mode 100644 index e9751806c86..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/number_with_validations.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **number_with_validations** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of outer number types | -| Path | "/fake/refs/number" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, decimal.Decimal, int, float] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input number as post body - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberWithValidations](../../../components/schema/number_with_validations.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output number - -## ResponseFor200 - -### Description -Output number - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[NumberWithValidations](../../../components/schema/number_with_validations.md) | decimal.Decimal, int, float | decimal.Decimal | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = number_with_validations.NumberWithValidations(10) - try: - api_response = api_instance.number_with_validations( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->number_with_validations: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_in_query.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_in_query.md deleted file mode 100644 index 66b26c3d051..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_in_query.md +++ /dev/null @@ -1,106 +0,0 @@ - -# **object_in_query** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | user list | -| Path | "/fake/objInQuery" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -mapBean | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict | | optional - - -#### Parameter0 - -##### Description -mapBean - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -###### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**keyword** | str | str | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - query_params = { - 'mapBean': dict( - keyword="keyword_example", - ), - } - try: - # user list - api_response = api_instance.object_in_query( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->object_in_query: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_model_with_ref_props.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_model_with_ref_props.md deleted file mode 100644 index 12b369d5590..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/object_model_with_ref_props.md +++ /dev/null @@ -1,122 +0,0 @@ - -# **object_model_with_ref_props** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of object with $refed properties | -| Path | "/fake/refs/object_model_with_ref_props" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input model - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectModelWithRefProps](../../../components/schema/object_model_with_ref_props.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model - -## ResponseFor200 - -### Description -Output model - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ObjectModelWithRefProps](../../../components/schema/object_model_with_ref_props.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = object_model_with_ref_props.ObjectModelWithRefProps( - my_number=number_with_validations.NumberWithValidations(10), - my_string=string.String("my_string_example"), - my_boolean=boolean.Boolean(True), - ) - try: - api_response = api_instance.object_model_with_ref_props( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->object_model_with_ref_props: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/parameter_collisions.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/parameter_collisions.md deleted file mode 100644 index c724d1278e1..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/parameter_collisions.md +++ /dev/null @@ -1,399 +0,0 @@ - -# **parameter_collisions** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | parameter collision case | -| Path | "/fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -[cookie_params](#cookie-params) | [RequestCookieParameters.Params](#requestcookieparametersparams), dict | | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -1 | [Parameter0.schema](#parameter0-schema), str | | optional -aB | [Parameter1.schema](#parameter1-schema), str | | optional -Ab | [Parameter2.schema](#parameter2-schema), str | | optional -self | [Parameter3.schema](#parameter3-schema), str | | optional -A-B | [Parameter4.schema](#parameter4-schema), str | | optional - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter1 - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter2 - -##### Parameter2 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter3 - -##### Parameter3 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter4 - -##### Parameter4 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### header_params -#### RequestHeaderParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -1 | [Parameter5.schema](#parameter5-schema), str | | optional -aB | [Parameter6.schema](#parameter6-schema), str | | optional -self | [Parameter7.schema](#parameter7-schema), str | | optional -A-B | [Parameter8.schema](#parameter8-schema), str | | optional - - -#### Parameter5 - -##### Parameter5 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter6 - -##### Parameter6 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter7 - -##### Parameter7 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter8 - -##### Parameter8 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -1 | [Parameter9.schema](#parameter9-schema), str | | -aB | [Parameter10.schema](#parameter10-schema), str | | -Ab | [Parameter11.schema](#parameter11-schema), str | | -self | [Parameter12.schema](#parameter12-schema), str | | -A-B | [Parameter13.schema](#parameter13-schema), str | | - - -#### Parameter9 - -##### Parameter9 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter10 - -##### Parameter10 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter11 - -##### Parameter11 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter12 - -##### Parameter12 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter13 - -##### Parameter13 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### cookie_params -#### RequestCookieParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -1 | [Parameter14.schema](#parameter14-schema), str | | optional -aB | [Parameter15.schema](#parameter15-schema), str | | optional -Ab | [Parameter16.schema](#parameter16-schema), str | | optional -self | [Parameter17.schema](#parameter17-schema), str | | optional -A-B | [Parameter18.schema](#parameter18-schema), str | | optional - - -#### Parameter14 - -##### Parameter14 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter15 - -##### Parameter15 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter16 - -##### Parameter16 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter17 - -##### Parameter17 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter18 - -##### Parameter18 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - '1': "1_example", - 'aB': "aB_example", - 'Ab': "Ab_example", - 'self': "self_example", - 'A-B': "A-B_example", - } - query_params = { - } - cookie_params = { - } - header_params = { - } - try: - # parameter collision case - api_response = api_instance.parameter_collisions( - path_params=path_params, - query_params=query_params, - header_params=header_params, - cookie_params=cookie_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->parameter_collisions: %s\n" % e) - - # example passing only optional values - path_params = { - '1': "1_example", - 'aB': "aB_example", - 'Ab': "Ab_example", - 'self': "self_example", - 'A-B': "A-B_example", - } - query_params = { - '1': "1_example", - 'aB': "aB_example", - 'Ab': "Ab_example", - 'self': "self_example", - 'A-B': "A-B_example", - } - cookie_params = { - '1': "1_example", - 'aB': "aB_example", - 'Ab': "Ab_example", - 'self': "self_example", - 'A-B': "A-B_example", - } - header_params = { - '1': "1_example", - 'aB': "aB_example", - 'self': "self_example", - 'A-B': "A-B_example", - } - body = None - try: - # parameter collision case - api_response = api_instance.parameter_collisions( - path_params=path_params, - query_params=query_params, - header_params=header_params, - cookie_params=cookie_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->parameter_collisions: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_param_with_json_content_type.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_param_with_json_content_type.md deleted file mode 100644 index 7e00a085434..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_param_with_json_content_type.md +++ /dev/null @@ -1,128 +0,0 @@ - -# **query_param_with_json_content_type** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | query param with json content-type | -| Path | "/fake/queryParamWithJsonContentType" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -someParam | [Parameter0.content.application_json.schema](#parameter0-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 | | - - -#### Parameter0 - -##### Description -The internal object id - -##### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#parameter0-content-applicationjson-schema) -##### Parameter0 content ApplicationJson Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success - -## ResponseFor200 - -### Description -success - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'someParam': , - } - try: - # query param with json content-type - api_response = api_instance.query_param_with_json_content_type( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->query_param_with_json_content_type: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_parameter_collection_format.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_parameter_collection_format.md deleted file mode 100644 index 4e388faad05..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/query_parameter_collection_format.md +++ /dev/null @@ -1,184 +0,0 @@ - -# **query_parameter_collection_format** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | To test the collection format in query parameters | -| Path | "/fake/test-query-paramters" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -pipe | [Parameter0.schema](#parameter0-schema), list, tuple | | -ioutil | [Parameter1.schema](#parameter1-schema), list, tuple | | -http | [Parameter2.schema](#parameter2-schema), list, tuple | | -url | [Parameter3.schema](#parameter3-schema), list, tuple | | -context | [Parameter4.schema](#parameter4-schema), list, tuple | | -refParam | [Parameter5.schema](#parameter5-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -#### Parameter1 - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -#### Parameter2 - -##### Parameter2 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -#### Parameter3 - -##### Parameter3 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -#### Parameter4 - -##### Parameter4 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -#### Parameter5 - -##### Parameter5 Schema - -###### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringWithValidation](../../../components/schema/string_with_validation.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'pipe': [ - "pipe_example" - ], - 'ioutil': [ - "ioutil_example" - ], - 'http': [ - "http_example" - ], - 'url': [ - "url_example" - ], - 'context': [ - "context_example" - ], - 'refParam': string_with_validation.StringWithValidation("refParam_example"), - } - try: - api_response = api_instance.query_parameter_collection_format( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->query_parameter_collection_format: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/ref_object_in_query.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/ref_object_in_query.md deleted file mode 100644 index 302ffc9427b..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/ref_object_in_query.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **ref_object_in_query** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | user list | -| Path | "/fake/refObjInQuery" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -mapBean | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | optional - - -#### Parameter0 - -##### Description -mapBean - -##### Parameter0 Schema - -###### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Foo](../../../components/schema/foo.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - query_params = { - 'mapBean': foo.Foo( - bar=bar.Bar("bar"), - ), - } - try: - # user list - api_response = api_instance.ref_object_in_query( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->ref_object_in_query: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/response_without_schema.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/response_without_schema.md deleted file mode 100644 index b2da9ceafeb..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/response_without_schema.md +++ /dev/null @@ -1,90 +0,0 @@ - -# **response_without_schema** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | receives a response without schema | -| Path | "/fake/responseWithoutSchema" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", "application/xml", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | contents without schema definition, multiple content types - -## ResponseFor200 - -### Description -contents without schema definition, multiple content types - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | Unset | body was not defined | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | no schema defined -"application/xml" | no schema defined - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # receives a response without schema - api_response = api_instance.response_without_schema() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->response_without_schema: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string.md deleted file mode 100644 index 892a3c5c20d..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **string** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of outer string types | -| Path | "/fake/refs/string" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, str] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input string as post body - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[String](../../../components/schema/string.md) | str | str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output string - -## ResponseFor200 - -### Description -Output string - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[String](../../../components/schema/string.md) | str | str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = string.String("string_example") - try: - api_response = api_instance.string( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->string: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string_enum.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string_enum.md deleted file mode 100644 index 74cb736b958..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/string_enum.md +++ /dev/null @@ -1,118 +0,0 @@ - -# **string_enum** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Description | Test serialization of outer enum | -| Path | "/fake/refs/enum" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, None, str] | optional, default is unset | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Input enum - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringEnum](../../../components/schema/string_enum.md) | None, str | NoneClass, str | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output enum - -## ResponseFor200 - -### Description -Output enum - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[StringEnum](../../../components/schema/string_enum.md) | None, str | NoneClass, str | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = string_enum.StringEnum("placed") - try: - api_response = api_instance.string_enum( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->string_enum: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_download_file.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_download_file.md deleted file mode 100644 index 11d68fe7349..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_download_file.md +++ /dev/null @@ -1,122 +0,0 @@ - -# **upload_download_file** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | uploads a file and downloads a file using application/octet-stream | -| Path | "/fake/uploadDownloadFile" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_octet_stream.schema](#RequestBody-content-applicationoctetstream-schema), bytes, io.FileIO, io.BufferedReader] | required | -content_type | str | optional, default is 'application/octet-stream' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/octet-stream", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/octet-stream" | [content.application_octet_stream.Schema](#requestbody-content-applicationoctetstream-schema) - -#### RequestBody content ApplicationOctetStream Schema - -##### Description -file to upload - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_octet_stream.schema](#responsefor200-content-applicationoctetstream-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/octet-stream" | [content.application_octet_stream.Schema](#responsefor200-content-applicationoctetstream-schema) - -### Body Details -#### ResponseFor200 content ApplicationOctetStream Schema - -##### Description -file to download - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to download | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only required values which don't have defaults set - body = open('/path/to/file', 'rb') - try: - # uploads a file and downloads a file using application/octet-stream - api_response = api_instance.upload_download_file( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->upload_download_file: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_file.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_file.md deleted file mode 100644 index 23dd788d93e..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_file.md +++ /dev/null @@ -1,126 +0,0 @@ - -# **upload_file** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | uploads a file using multipart/form-data | -| Path | "/fake/uploadFile" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) - -#### RequestBody content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**file** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | -**additionalMetadata** | str | str | Additional data to pass to server | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ApiResponse](../../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = dict( - additional_metadata="additional_metadata_example", - file=open('/path/to/file', 'rb'), - ) - try: - # uploads a file using multipart/form-data - api_response = api_instance.upload_file( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->upload_file: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_files.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_files.md deleted file mode 100644 index eabfb2eb523..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_api/upload_files.md +++ /dev/null @@ -1,138 +0,0 @@ - -# **upload_files** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | uploads files using multipart/form-data | -| Path | "/fake/uploadFiles" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) - -#### RequestBody content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**files** | list, tuple | [properties.Files](#requestbody-content-multipartformdata-schema-properties-files) | | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -#### RequestBody content MultipartFormData Schema properties Files - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -##### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ApiResponse](../../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_api.FakeApi(api_client) - - # example passing only optional values - body = dict( - files=[ - open('/path/to/file', 'rb') - ], - ) - try: - # uploads files using multipart/form-data - api_response = api_instance.upload_files( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeApi->upload_files: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api.md index 6b2309bcd51..03a78ae2221 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api.md @@ -9,6 +9,6 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**classname**](fake_classname_tags123_api/classname.md) | To test class name in snake case +[**classname**](../../paths/fake_classname_test/patch.md) | To test class name in snake case [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api/classname.md b/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api/classname.md deleted file mode 100644 index 64b9d037580..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/fake_classname_tags123_api/classname.md +++ /dev/null @@ -1,131 +0,0 @@ - -# **classname** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | To test class name in snake case | -| Description | To test class name in snake case | -| Path | "/fake_classname_test" | -| HTTP Method | patch | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Client](../../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key_query"](../../../components/security_schemes/security_scheme_api_key_query.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import fake_classname_tags123_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key_query - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key_query": security_scheme_api_key_query.ApiKeyQuery( - api_key='sampleApiKeyValue' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = fake_classname_tags123_api.FakeClassnameTags123Api(api_client) - - # example passing only required values which don't have defaults set - body = client.Client( - client="client_example", - ) - try: - # To test class name in snake case - api_response = api_instance.classname( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling FakeClassnameTags123Api->classname: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../fake_classname_tags123_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api.md index f12a7223db0..712c3394921 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api.md @@ -12,14 +12,14 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**add_pet**](pet_api/add_pet.md) | Add a new pet to the store -[**delete_pet**](pet_api/delete_pet.md) | Deletes a pet -[**find_pets_by_status**](pet_api/find_pets_by_status.md) | Finds Pets by status -[**find_pets_by_tags**](pet_api/find_pets_by_tags.md) | Finds Pets by tags -[**get_pet_by_id**](pet_api/get_pet_by_id.md) | Find pet by ID -[**update_pet**](pet_api/update_pet.md) | Update an existing pet -[**update_pet_with_form**](pet_api/update_pet_with_form.md) | Updates a pet in the store with form data -[**upload_file_with_required_file**](pet_api/upload_file_with_required_file.md) | uploads an image (required) -[**upload_image**](pet_api/upload_image.md) | uploads an image +[**add_pet**](../../paths/pet/post.md) | Add a new pet to the store +[**delete_pet**](../../paths/pet_pet_id/delete.md) | Deletes a pet +[**find_pets_by_status**](../../paths/pet_find_by_status/get.md) | Finds Pets by status +[**find_pets_by_tags**](../../paths/pet_find_by_tags/get.md) | Finds Pets by tags +[**get_pet_by_id**](../../paths/pet_pet_id/get.md) | Find pet by ID +[**update_pet**](../../paths/pet/put.md) | Update an existing pet +[**update_pet_with_form**](../../paths/pet_pet_id/post.md) | Updates a pet in the store with form data +[**upload_file_with_required_file**](../../paths/fake_pet_id_upload_image_with_required_file/post.md) | uploads an image (required) +[**upload_image**](../../paths/pet_pet_id_upload_image/post.md) | uploads an image [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/add_pet.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/add_pet.md deleted file mode 100644 index f304a3a9600..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/add_pet.md +++ /dev/null @@ -1,171 +0,0 @@ - -# **add_pet** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Add a new pet to the store | -| Description | Add a new pet to the store | -| Path | "/pet" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_pet.md) | typing.Union[[Pet.content.application_json.schema](../../../components/request_bodies/request_body_pet.md#content-applicationjson-schema), [Pet.content.application_xml.schema](../../../components/request_bodies/request_body_pet.md#content-applicationxml-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success -405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Invalid input - -## ResponseFor405 - -### Description -Invalid input - -### ResponseFor405 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["http_signature_test"](../../../components/security_schemes/security_scheme_http_signature_test.md) []
| -| 2 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_http_signature_test -# security_index 2 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( - signing_info=petstore_api.signing.HttpSigningConfiguration( - key_id='my-key-id', - private_key_path='rsa.pem', - signing_scheme=petstore_api.signing.SCHEME_HS2019, - signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, - signed_headers=[ - petstore_api.signing.HEADER_REQUEST_TARGET, - petstore_api.signing.HEADER_CREATED, - petstore_api.signing.HEADER_EXPIRES, - petstore_api.signing.HEADER_HOST, - petstore_api.signing.HEADER_DATE, - petstore_api.signing.HEADER_DIGEST, - 'Content-Type', - 'User-Agent' - ], - signature_max_validity=datetime.timedelta(minutes=5) - ) - - ), -} - - -# security_scheme_info for security_index 2 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - body = pet.Pet( - id=1, - category=category.Category( - id=1, - name="default-name", - ), - name="doggie", - photo_urls=[ - "photo_urls_example" - ], - tags=[ - tag.Tag( - id=1, - name="name_example", - ) - ], - status="available", - ) - try: - # Add a new pet to the store - api_response = api_instance.add_pet( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->add_pet: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/delete_pet.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/delete_pet.md deleted file mode 100644 index bc9d60ce137..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/delete_pet.md +++ /dev/null @@ -1,185 +0,0 @@ - -# **delete_pet** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Deletes a pet | -| Path | "/pet/{petId}" | -| HTTP Method | delete | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### header_params -#### RequestHeaderParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -api_key | [Parameter0.schema](#parameter0-schema), str | | optional - - -#### Parameter0 - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -petId | [Parameter1.schema](#parameter1-schema), decimal.Decimal, int | | - - -#### Parameter1 - -##### Description -Pet id to delete - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid pet value - -## ResponseFor400 - -### Description -Invalid pet value - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'petId': 1, - } - header_params = { - } - try: - # Deletes a pet - api_response = api_instance.delete_pet( - path_params=path_params, - header_params=header_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->delete_pet: %s\n" % e) - - # example passing only optional values - path_params = { - 'petId': 1, - } - header_params = { - 'api_key': "api_key_example", - } - try: - # Deletes a pet - api_response = api_instance.delete_pet( - path_params=path_params, - header_params=header_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->delete_pet: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_status.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_status.md deleted file mode 100644 index 39960fc30aa..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_status.md +++ /dev/null @@ -1,197 +0,0 @@ - -# **find_pets_by_status** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Finds Pets by status | -| Description | Multiple status values can be provided with comma separated strings | -| Path | "/pet/findByStatus" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -status | [Parameter0.schema](#parameter0-schema), list, tuple | | - - -#### Parameter0 - -##### Description -Status values that need to be considered for filter - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | must be one of ["available", "pending", "sold"] if omitted the server will use the default value of available - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessfulXmlAndJsonArrayOfPet.response_cls](../../../components/responses/response_successful_xml_and_json_array_of_pet.md#response_successful_xml_and_json_array_of_petresponse_cls) | successful operation, multiple content types -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid status value - -## ResponseFor400 - -### Description -Invalid status value - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["http_signature_test"](../../../components/security_schemes/security_scheme_http_signature_test.md) []
| -| 2 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are specific to this "/pet/findByStatus" path -- defaults to server_index=0, server.url = https://path-server-test.petstore.local/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](#server0) | -1 | [Server1](#server1) | - -### Server0 - -#### Url -https://path-server-test.petstore.local/v2 -### Server1 - -#### Url -https://petstore.swagger.io/{version} - -#### Variables -Key | Type | Description | Notes ---- | ---- | ----------- | ------ -**version** | str | | must be one of ["v1", "v2"] if omitted the client will use the default value of v1 - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_http_signature_test -# security_index 2 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( - signing_info=petstore_api.signing.HttpSigningConfiguration( - key_id='my-key-id', - private_key_path='rsa.pem', - signing_scheme=petstore_api.signing.SCHEME_HS2019, - signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, - signed_headers=[ - petstore_api.signing.HEADER_REQUEST_TARGET, - petstore_api.signing.HEADER_CREATED, - petstore_api.signing.HEADER_EXPIRES, - petstore_api.signing.HEADER_HOST, - petstore_api.signing.HEADER_DATE, - petstore_api.signing.HEADER_DIGEST, - 'Content-Type', - 'User-Agent' - ], - signature_max_validity=datetime.timedelta(minutes=5) - ) - - ), -} - - -# security_scheme_info for security_index 2 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'status': [ - "available" - ], - } - try: - # Finds Pets by status - api_response = api_instance.find_pets_by_status( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->find_pets_by_status: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_tags.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_tags.md deleted file mode 100644 index 8baed3fe565..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/find_pets_by_tags.md +++ /dev/null @@ -1,172 +0,0 @@ - -# **find_pets_by_tags** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Finds Pets by tags | -| Description | Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. | -| Path | "/pet/findByTags" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -tags | [Parameter0.schema](#parameter0-schema), list, tuple | | - - -#### Parameter0 - -##### Description -Tags to filter by - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -list, tuple | tuple | | - -###### List Items -Class Name | Input Type | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- | ------------- -items | str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [RefSuccessfulXmlAndJsonArrayOfPet.response_cls](../../../components/responses/response_ref_successful_xml_and_json_array_of_pet.md#response_ref_successful_xml_and_json_array_of_petresponse_cls) | successful operation, multiple content types -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid tag value - -## ResponseFor400 - -### Description -Invalid tag value - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["http_signature_test"](../../../components/security_schemes/security_scheme_http_signature_test.md) []
| -| 1 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_http_signature_test -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( - signing_info=petstore_api.signing.HttpSigningConfiguration( - key_id='my-key-id', - private_key_path='rsa.pem', - signing_scheme=petstore_api.signing.SCHEME_HS2019, - signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, - signed_headers=[ - petstore_api.signing.HEADER_REQUEST_TARGET, - petstore_api.signing.HEADER_CREATED, - petstore_api.signing.HEADER_EXPIRES, - petstore_api.signing.HEADER_HOST, - petstore_api.signing.HEADER_DATE, - petstore_api.signing.HEADER_DIGEST, - 'Content-Type', - 'User-Agent' - ], - signature_max_validity=datetime.timedelta(minutes=5) - ) - - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'tags': [ - "tags_example" - ], - } - try: - # Finds Pets by tags - api_response = api_instance.find_pets_by_tags( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->find_pets_by_tags: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/get_pet_by_id.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/get_pet_by_id.md deleted file mode 100644 index 820fb2c90de..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/get_pet_by_id.md +++ /dev/null @@ -1,184 +0,0 @@ - -# **get_pet_by_id** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Find pet by ID | -| Description | Returns a single pet | -| Path | "/pet/{petId}" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | - - -#### Parameter0 - -##### Description -ID of pet to return - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Pet not found - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationXml Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Pet](../../../components/schema/pet.md) | dict, frozendict.frozendict | frozendict.frozendict | -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[RefPet](../../../components/schema/ref_pet.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## ResponseFor400 - -### Description -Invalid ID supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -Pet not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'petId': 1, - } - try: - # Find pet by ID - api_response = api_instance.get_pet_by_id( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->get_pet_by_id: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet.md deleted file mode 100644 index 3a15af00c5b..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet.md +++ /dev/null @@ -1,184 +0,0 @@ - -# **update_pet** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Update an existing pet | -| Path | "/pet" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_pet.md) | typing.Union[[Pet.content.application_json.schema](../../../components/request_bodies/request_body_pet.md#content-applicationjson-schema), [Pet.content.application_xml.schema](../../../components/request_bodies/request_body_pet.md#content-applicationxml-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Pet not found -405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Validation exception - -## ResponseFor400 - -### Description -Invalid ID supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -Pet not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor405 - -### Description -Validation exception - -### ResponseFor405 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["http_signature_test"](../../../components/security_schemes/security_scheme_http_signature_test.md) []
| -| 1 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_http_signature_test -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( - signing_info=petstore_api.signing.HttpSigningConfiguration( - key_id='my-key-id', - private_key_path='rsa.pem', - signing_scheme=petstore_api.signing.SCHEME_HS2019, - signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, - signed_headers=[ - petstore_api.signing.HEADER_REQUEST_TARGET, - petstore_api.signing.HEADER_CREATED, - petstore_api.signing.HEADER_EXPIRES, - petstore_api.signing.HEADER_HOST, - petstore_api.signing.HEADER_DATE, - petstore_api.signing.HEADER_DIGEST, - 'Content-Type', - 'User-Agent' - ], - signature_max_validity=datetime.timedelta(minutes=5) - ) - - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - body = pet.Pet( - id=1, - category=category.Category( - id=1, - name="default-name", - ), - name="doggie", - photo_urls=[ - "photo_urls_example" - ], - tags=[ - tag.Tag( - id=1, - name="name_example", - ) - ], - status="available", - ) - try: - # Update an existing pet - api_response = api_instance.update_pet( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->update_pet: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet_with_form.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet_with_form.md deleted file mode 100644 index b296f05694f..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/update_pet_with_form.md +++ /dev/null @@ -1,187 +0,0 @@ - -# **update_pet_with_form** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Updates a pet in the store with form data | -| Path | "/pet/{petId}" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) - -#### RequestBody content ApplicationXWwwFormUrlencoded Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**name** | str | str | Updated name of the pet | [optional] -**status** | str | str | Updated status of the pet | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | - - -#### Parameter0 - -##### Description -ID of pet that needs to be updated - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Invalid input - -## ResponseFor405 - -### Description -Invalid input - -### ResponseFor405 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| -| 1 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key -# security_index 1 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - - -# security_scheme_info for security_index 1 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'petId': 1, - } - try: - # Updates a pet in the store with form data - api_response = api_instance.update_pet_with_form( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->update_pet_with_form: %s\n" % e) - - # example passing only optional values - path_params = { - 'petId': 1, - } - body = dict( - name="name_example", - status="status_example", - ) - try: - # Updates a pet in the store with form data - api_response = api_instance.update_pet_with_form( - path_params=path_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->update_pet_with_form: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_file_with_required_file.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_file_with_required_file.md deleted file mode 100644 index 598bd0e0c2a..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_file_with_required_file.md +++ /dev/null @@ -1,190 +0,0 @@ - -# **upload_file_with_required_file** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | uploads an image (required) | -| Path | "/fake/{petId}/uploadImageWithRequiredFile" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) - -#### RequestBody content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**requiredFile** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | -**additionalMetadata** | str | str | Additional data to pass to server | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | - - -#### Parameter0 - -##### Description -ID of pet to update - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[ApiResponse](../../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'petId': 1, - } - try: - # uploads an image (required) - api_response = api_instance.upload_file_with_required_file( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->upload_file_with_required_file: %s\n" % e) - - # example passing only optional values - path_params = { - 'petId': 1, - } - body = dict( - additional_metadata="additional_metadata_example", - required_file=open('/path/to/file', 'rb'), - ) - try: - # uploads an image (required) - api_response = api_instance.upload_file_with_required_file( - path_params=path_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->upload_file_with_required_file: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_image.md b/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_image.md deleted file mode 100644 index f094f467e52..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/pet_api/upload_image.md +++ /dev/null @@ -1,165 +0,0 @@ - -# **upload_image** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | uploads an image | -| Path | "/pet/{petId}/uploadImage" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) - -#### RequestBody content MultipartFormData Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -dict, frozendict.frozendict | frozendict.frozendict | | - -##### Dictionary Keys -Key | Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- | ------------- -**additionalMetadata** | str | str | Additional data to pass to server | [optional] -**file** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | [optional] -**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | - - -#### Parameter0 - -##### Description -ID of pet to update - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessWithJsonApiResponse.response_cls](../../../components/responses/response_success_with_json_api_response.md#response_success_with_json_api_responseresponse_cls) | successful operation - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["petstore_auth"](../../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import pet_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_petstore_auth - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = pet_api.PetApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'petId': 1, - } - try: - # uploads an image - api_response = api_instance.upload_image( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->upload_image: %s\n" % e) - - # example passing only optional values - path_params = { - 'petId': 1, - } - body = dict( - additional_metadata="additional_metadata_example", - file=open('/path/to/file', 'rb'), - ) - try: - # uploads an image - api_response = api_instance.upload_image( - path_params=path_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling PetApi->upload_image: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../pet_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api.md index 5dffd5c1080..2b031a628e1 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api.md @@ -12,9 +12,9 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**delete_order**](store_api/delete_order.md) | Delete purchase order by ID -[**get_inventory**](store_api/get_inventory.md) | Returns pet inventories by status -[**get_order_by_id**](store_api/get_order_by_id.md) | Find purchase order by ID -[**place_order**](store_api/place_order.md) | Place an order for a pet +[**delete_order**](../../paths/store_order_order_id/delete.md) | Delete purchase order by ID +[**get_inventory**](../../paths/store_inventory/get.md) | Returns pet inventories by status +[**get_order_by_id**](../../paths/store_order_order_id/get.md) | Find purchase order by ID +[**place_order**](../../paths/store_order/post.md) | Place an order for a pet [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/delete_order.md b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/delete_order.md deleted file mode 100644 index b5e9cf2a5c3..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/delete_order.md +++ /dev/null @@ -1,124 +0,0 @@ - -# **delete_order** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Delete purchase order by ID | -| Description | For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors | -| Path | "/store/order/{order_id}" | -| HTTP Method | delete | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -order_id | [Parameter0.schema](#parameter0-schema), str | | - - -#### Parameter0 - -##### Description -ID of the order that needs to be deleted - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Order not found - -## ResponseFor400 - -### Description -Invalid ID supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -Order not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import store_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = store_api.StoreApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'order_id': "order_id_example", - } - try: - # Delete purchase order by ID - api_response = api_instance.delete_order( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling StoreApi->delete_order: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../store_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_inventory.md b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_inventory.md deleted file mode 100644 index 227c7d036a7..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_inventory.md +++ /dev/null @@ -1,99 +0,0 @@ - -# **get_inventory** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Security](#security) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Returns pet inventories by status | -| Description | Returns a map of status codes to quantities | -| Path | "/store/inventory" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessInlineContentAndHeader.response_cls](../../../components/responses/response_success_inline_content_and_header.md#response_success_inline_content_and_headerresponse_cls) | successful operation - -## Security - -Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the -key is the below security scheme quoted name, and the value is an instance of the linked -component security scheme class. -Select the security index by setting ApiConfiguration.security_index_info or by -passing in security_index into the endpoint method. -See how to do this in the code sample. -- these securities are specific to this to this endpoint - -| Security Index | Security Scheme to Scope Names | -| -------------- | ------------------------------ | -| 0 | ["api_key"](../../../components/security_schemes/security_scheme_api_key.md) []
| - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import store_api -from pprint import pprint -# security_index 0 -from petstore_api.components.security_schemes import security_scheme_api_key - -# security_scheme_info for security_index 0 -security_scheme_info: api_configuration.SecuritySchemeInfo = { - "api_key": security_scheme_api_key.ApiKey( - api_key='sampleApiKeyValue' - ), -} - -used_configuration = api_configuration.ApiConfiguration( - security_scheme_info=security_scheme_info -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = store_api.StoreApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Returns pet inventories by status - api_response = api_instance.get_inventory() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling StoreApi->get_inventory: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../store_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_order_by_id.md b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_order_by_id.md deleted file mode 100644 index ad1e1328b0b..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/get_order_by_id.md +++ /dev/null @@ -1,158 +0,0 @@ - -# **get_order_by_id** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Find purchase order by ID | -| Description | For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions | -| Path | "/store/order/{order_id}" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -order_id | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | - - -#### Parameter0 - -##### Description -ID of pet that needs to be fetched - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Order not found - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationXml Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Order](../../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Order](../../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## ResponseFor400 - -### Description -Invalid ID supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -Order not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import store_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = store_api.StoreApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'order_id': 1, - } - try: - # Find purchase order by ID - api_response = api_instance.get_order_by_id( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling StoreApi->get_order_by_id: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../store_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/place_order.md b/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/place_order.md deleted file mode 100644 index 9334b9c4501..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/store_api/place_order.md +++ /dev/null @@ -1,146 +0,0 @@ - -# **place_order** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Place an order for a pet | -| Path | "/store/order" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -order placed for purchasing the pet - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Order](../../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid Order - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationXml Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Order](../../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[Order](../../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## ResponseFor400 - -### Description -Invalid Order - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import store_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = store_api.StoreApi(api_client) - - # example passing only required values which don't have defaults set - body = order.Order( - id=1, - pet_id=1, - quantity=1, - ship_date="2020-02-02T20:20:20.000222Z", - status="placed", - complete=False, - ) - try: - # Place an order for a pet - api_response = api_instance.place_order( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling StoreApi->place_order: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../store_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api.md index a06bd74e017..55b7c628c58 100644 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api.md +++ b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api.md @@ -12,13 +12,13 @@ All URIs are relative to the selected server Method | Description ------ | ------------- -[**create_user**](user_api/create_user.md) | Create user -[**create_users_with_array_input**](user_api/create_users_with_array_input.md) | Creates list of users with given input array -[**create_users_with_list_input**](user_api/create_users_with_list_input.md) | Creates list of users with given input array -[**delete_user**](user_api/delete_user.md) | Delete user -[**get_user_by_name**](user_api/get_user_by_name.md) | Get user by user name -[**login_user**](user_api/login_user.md) | Logs user into the system -[**logout_user**](user_api/logout_user.md) | Logs out current logged in user session -[**update_user**](user_api/update_user.md) | Updated user +[**create_user**](../../paths/user/post.md) | Create user +[**create_users_with_array_input**](../../paths/user_create_with_array/post.md) | Creates list of users with given input array +[**create_users_with_list_input**](../../paths/user_create_with_list/post.md) | Creates list of users with given input array +[**delete_user**](../../paths/user_username/delete.md) | Delete user +[**get_user_by_name**](../../paths/user_username/get.md) | Get user by user name +[**login_user**](../../paths/user_login/get.md) | Logs user into the system +[**logout_user**](../../paths/user_logout/get.md) | Logs out current logged in user session +[**update_user**](../../paths/user_username/put.md) | Updated user [[Back to top]](#top) [[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_user.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_user.md deleted file mode 100644 index 29bb85386e0..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_user.md +++ /dev/null @@ -1,120 +0,0 @@ - -# **create_user** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Create user | -| Description | This can only be done by the logged in user. | -| Path | "/user" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Created user object - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[User](../../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [Default.response_cls](#default-response_cls) | successful operation - -## Default - -### Description -successful operation - -### Default response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - body = user.User( - id=1, - username="username_example", - first_name="first_name_example", - last_name="last_name_example", - email="email_example", - password="password_example", - phone="phone_example", - user_status=1, - object_with_no_declared_props=dict(), - object_with_no_declared_props_nullable=dict(), - any_type_prop=None, - any_type_except_null_prop=None, - any_type_prop_nullable=None, - ) - try: - # Create user - api_response = api_instance.create_user( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->create_user: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_array_input.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_array_input.md deleted file mode 100644 index fb2855299f2..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_array_input.md +++ /dev/null @@ -1,104 +0,0 @@ - -# **create_users_with_array_input** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Creates list of users with given input array | -| Path | "/user/createWithArray" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_user_array.md) | typing.Union[[UserArray.content.application_json.schema](../../../components/request_bodies/request_body_user_array.md#content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [Default.response_cls](#default-response_cls) | successful operation - -## Default - -### Description -successful operation - -### Default response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - body = [ - user.User( - id=1, - username="username_example", - first_name="first_name_example", - last_name="last_name_example", - email="email_example", - password="password_example", - phone="phone_example", - user_status=1, - object_with_no_declared_props=dict(), - object_with_no_declared_props_nullable=dict(), - any_type_prop=None, - any_type_except_null_prop=None, - any_type_prop_nullable=None, - ) - ] - try: - # Creates list of users with given input array - api_response = api_instance.create_users_with_array_input( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_list_input.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_list_input.md deleted file mode 100644 index 8356af9158e..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/create_users_with_list_input.md +++ /dev/null @@ -1,104 +0,0 @@ - -# **create_users_with_list_input** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Creates list of users with given input array | -| Path | "/user/createWithList" | -| HTTP Method | post | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[**body**](../../../components/request_bodies/request_body_ref_user_array.md) | typing.Union[[RefUserArray.content.application_json.schema](../../../components/request_bodies/request_body_ref_user_array.md#content-applicationjson-schema), list, tuple] | required | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [Default.response_cls](#default-response_cls) | successful operation - -## Default - -### Description -successful operation - -### Default response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - body = [ - user.User( - id=1, - username="username_example", - first_name="first_name_example", - last_name="last_name_example", - email="email_example", - password="password_example", - phone="phone_example", - user_status=1, - object_with_no_declared_props=dict(), - object_with_no_declared_props_nullable=dict(), - any_type_prop=None, - any_type_except_null_prop=None, - any_type_prop_nullable=None, - ) - ] - try: - # Creates list of users with given input array - api_response = api_instance.create_users_with_list_input( - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/delete_user.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/delete_user.md deleted file mode 100644 index f08ef395835..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/delete_user.md +++ /dev/null @@ -1,100 +0,0 @@ - -# **delete_user** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Delete user | -| Description | This can only be done by the logged in user. | -| Path | "/user/{username}" | -| HTTP Method | delete | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -username | [RefPathUserName.schema](../../../components/parameters/parameter_ref_path_user_name.md#schema), str | | - - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [SuccessDescriptionOnly.response_cls](../../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found - -## ResponseFor404 - -### Description -User not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'username': "username_example", - } - try: - # Delete user - api_response = api_instance.delete_user( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->delete_user: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/get_user_by_name.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/get_user_by_name.md deleted file mode 100644 index 9e4175ee138..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/get_user_by_name.md +++ /dev/null @@ -1,145 +0,0 @@ - -# **get_user_by_name** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Get user by user name | -| Path | "/user/{username}" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -username | [PathUserName.schema](../../../components/parameters/parameter_path_user_name.md#schema), str | | - - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid username supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | -headers | Unset | headers were not defined | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Body Details -#### ResponseFor200 content ApplicationXml Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[User](../../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[User](../../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | - -## ResponseFor400 - -### Description -Invalid username supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -User not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'username': "username_example", - } - try: - # Get user by user name - api_response = api_instance.get_user_by_name( - path_params=path_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->get_user_by_name: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/login_user.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/login_user.md deleted file mode 100644 index 7d4dc6660ff..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/login_user.md +++ /dev/null @@ -1,198 +0,0 @@ - -# **login_user** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Logs user into the system | -| Path | "/user/login" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | -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 -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### query_params -#### RequestQueryParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -username | [Parameter0.schema](#parameter0-schema), str | | -password | [Parameter1.schema](#parameter1-schema), str | | - - -#### Parameter0 - -##### Description -The user name for login - -##### Parameter0 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -#### Parameter1 - -##### Description -The password for login in clear text - -##### Parameter1 Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid username/password supplied - -## ResponseFor200 - -### Description -successful operation - -### ResponseFor200 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | -[headers](#headers) | [Headers](#headers) | | - -### ResponseFor200 Body -Content-Type | Schema ------------- | ------- -"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) -"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) - -### Headers -Key | Accessed Type | Description | Notes -------------- | ------------- | ------------- | ------------- -ref-schema-header | [RefSchemaHeader.schema](../../../components/headers/header_ref_schema_header.md#schema) | | -X-Rate-Limit | [headers.header_x_rate_limit.content.application_json.schema](#responsefor200-headers-xratelimit-content-applicationjson-schema) | | -int32 | [Int32JsonContentTypeHeader.content.application_json.schema](../../../components/headers/header_int32_json_content_type_header.md#content-applicationjson-schema) | | -X-Expires-After | [headers.header_x_expires_after.schema](#responsefor200-headers-xexpiresafter-schema) | | optional -ref-content-schema-header | [RefContentSchemaHeader.content.application_json.schema](../../../components/headers/header_ref_content_schema_header.md#content-applicationjson-schema) | | -stringHeader | [RefStringHeader.schema](../../../components/headers/header_ref_string_header.md#schema) | | -numberHeader | [NumberHeader.schema](../../../components/headers/header_number_header.md#schema) | | optional - -### Body Details -#### ResponseFor200 content ApplicationXml Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | -#### ResponseFor200 content ApplicationJson Schema - -##### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str | str | | - -### Header Details -#### ResponseFor200 headers XRateLimit - -##### Description -calls per hour allowed by the user - -##### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#responsefor200-headers-xratelimit-content-applicationjson-schema) - -##### ResponseFor200 headers XRateLimit content ApplicationJson Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -decimal.Decimal, int | decimal.Decimal | | value must be a 32 bit integer -#### ResponseFor200 headers XExpiresAfter - -##### Description -date in UTC when token expires - -##### ResponseFor200 headers XExpiresAfter Schema - -###### Type Info -Input Type | Accessed Type | Description | Notes ------------- | ------------- | ------------- | ------------- -str, datetime.datetime | str | | value must conform to RFC-3339 date-time - -## ResponseFor400 - -### Description -Invalid username/password supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - query_params = { - 'username': "username_example", - 'password': "password_example", - } - try: - # Logs user into the system - api_response = api_instance.login_user( - query_params=query_params, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->login_user: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/logout_user.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/logout_user.md deleted file mode 100644 index 9c26d55773e..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/logout_user.md +++ /dev/null @@ -1,71 +0,0 @@ - -# **logout_user** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Logs out current logged in user session | -| Path | "/user/logout" | -| HTTP Method | get | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -default | [RefSuccessDescriptionOnly.response_cls](../../../components/responses/response_ref_success_description_only.md#response_ref_success_description_onlyresponse_cls) | Success - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # Logs out current logged in user session - api_response = api_instance.logout_user() - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->logout_user: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/update_user.md b/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/update_user.md deleted file mode 100644 index 206e354b980..00000000000 --- a/samples/openapi3/client/petstore/python/docs/apis/tags/user_api/update_user.md +++ /dev/null @@ -1,147 +0,0 @@ - -# **update_user** - -## Table of Contents -- [General Info](#general-info) -- [Arguments](#arguments) -- [Return Types](#return-types) -- [Servers](#servers) -- [Code Sample](#code-sample) - -## General Info -| Field | Value | -| ----- | ----- | -| Summary | Updated user | -| Description | This can only be done by the logged in user. | -| Path | "/user/{username}" | -| HTTP Method | put | - -## Arguments - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | -[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | -content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body -server_index | typing.Optional[int] | default is None | Allows one to select a different server -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 -timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client -skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned - -### RequestBody - -#### Description -Updated user object - -#### Content Type To Schema -Content-Type | Schema ------------- | ------- -"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) - -#### RequestBody content ApplicationJson Schema - -##### Type Info -Ref Class | Input Type | Accessed Type | Description ---------- | ---------- | ------------- | ------------ -[User](../../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | - -### path_params -#### RequestPathParameters.Params -This is a TypedDict - -Key | Input Type | Description | Notes -------------- | ------------- | ------------- | ------------- -username | [PathUserName.schema](../../../components/parameters/parameter_path_user_name.md#schema), str | | - - -## Return Types - -HTTP Status Code | Class | Description -------------- | ------------- | ------------- -n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned -400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid user supplied -404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found - -## ResponseFor400 - -### Description -Invalid user supplied - -### ResponseFor400 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## ResponseFor404 - -### Description -User not found - -### ResponseFor404 response_cls -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -response | urllib3.HTTPResponse | Raw response | -body | Unset | body was not defined | -headers | Unset | headers were not defined | - -## Servers - -Set the available servers by defining your used servers in ApiConfiguration.server_info -Then select your server by setting a server index in ApiConfiguration.server_index_info or by -passing server_index in to the endpoint method. -- these servers are the general api servers -- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 - -server_index | Class | Description ------------- | ----- | ------------ -0 | [Server0](../../../servers/server_0.md) | petstore server -1 | [Server1](../../../servers/server_1.md) | The local server -2 | [Server2](../../../servers/server_2.md) | staging server with no variables - -## Code Sample - -```python -import petstore_api -from petstore_api.configurations import api_configuration -from petstore_api.apis.tags import user_api -from pprint import pprint -used_configuration = api_configuration.ApiConfiguration( -) -# Enter a context with an instance of the API client -with petstore_api.ApiClient(used_configuration) as api_client: - # Create an instance of the API class - api_instance = user_api.UserApi(api_client) - - # example passing only required values which don't have defaults set - path_params = { - 'username': "username_example", - } - body = user.User( - id=1, - username="username_example", - first_name="first_name_example", - last_name="last_name_example", - email="email_example", - password="password_example", - phone="phone_example", - user_status=1, - object_with_no_declared_props=dict(), - object_with_no_declared_props_nullable=dict(), - any_type_prop=None, - any_type_except_null_prop=None, - any_type_prop_nullable=None, - ) - try: - # Updated user - api_response = api_instance.update_user( - path_params=path_params, - body=body, - ) - pprint(api_response) - except petstore_api.ApiException as e: - print("Exception when calling UserApi->update_user: %s\n" % e) -``` - -[[Back to top]](#top) [[Back to API]](../user_api.md) [[Back to Endpoints]](../../../../README.md#Endpoints) [[Back to README]](../../../../README.md) diff --git a/samples/openapi3/client/petstore/python/docs/paths/another_fake_dummy/patch.md b/samples/openapi3/client/petstore/python/docs/paths/another_fake_dummy/patch.md new file mode 100644 index 00000000000..b623ba50fd8 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/another_fake_dummy/patch.md @@ -0,0 +1,113 @@ +petstore_api.paths.another_fake_dummy.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| call_123_test__special_tags | [AnotherFakeApi](../../apis/tags/another_fake_api.md) | This api is only for tag=$another-fake? | +| patch | ApiForPatch | This api is only for this endpoint | +| patch | AnotherFakeDummy | This api is only for path=/another-fake/dummy | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | To test special tags | +| Description | To test special tags and operation ID starting with number | +| Path | "/another-fake/dummy" | +| HTTP Method | patch | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Client](../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import another_fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = another_fake_api.AnotherFakeApi(api_client) + + # example passing only required values which don't have defaults set + body = client.Client( + client="client_example", + ) + try: + # To test special tags + api_response = api_instance.call_123_test__special_tags( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling AnotherFakeApi->call_123_test__special_tags: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to AnotherFakeApi API]](../../apis/tags/another_fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake/delete.md b/samples/openapi3/client/petstore/python/docs/paths/fake/delete.md new file mode 100644 index 00000000000..aedb2cebb8c --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake/delete.md @@ -0,0 +1,233 @@ +petstore_api.paths.fake.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| group_parameters | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| delete | ApiForDelete | This api is only for this endpoint | +| delete | Fake | This api is only for path=/fake | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Fake endpoint to test group parameters (optional) | +| Description | Fake endpoint to test group parameters (optional) | +| Path | "/fake" | +| HTTP Method | delete | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +required_string_group | [Parameter0.schema](#parameter0-schema), str | | +required_int64_group | [Parameter2.schema](#parameter2-schema), decimal.Decimal, int | | +string_group | [Parameter3.schema](#parameter3-schema), str | | optional +int64_group | [Parameter5.schema](#parameter5-schema), decimal.Decimal, int | | optional + + +#### Parameter0 + +##### Description +Required String in group parameters + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter2 + +##### Description +Required Integer in group parameters + +##### Parameter2 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +#### Parameter3 + +##### Description +String in group parameters + +##### Parameter3 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter5 + +##### Description +Integer in group parameters + +##### Parameter5 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +### header_params +#### RequestHeaderParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +required_boolean_group | [Parameter1.schema](#parameter1-schema), str | | +boolean_group | [Parameter4.schema](#parameter4-schema), str | | optional + + +#### Parameter1 + +##### Description +Required Boolean in group parameters + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | must be one of ["true", "false"] + +#### Parameter4 + +##### Description +Boolean in group parameters + +##### Parameter4 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | must be one of ["true", "false"] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["bearer_test"](../../components/security_schemes/security_scheme_bearer_test.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_bearer_test + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "bearer_test": security_scheme_bearer_test.BearerTest( + access_token='someAccessToken' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'required_string_group': "required_string_group_example", + 'required_int64_group': 1, + } + header_params = { + 'required_boolean_group': "true", + } + try: + # Fake endpoint to test group parameters (optional) + api_response = api_instance.group_parameters( + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->group_parameters: %s\n" % e) + + # example passing only optional values + query_params = { + 'required_string_group': "required_string_group_example", + 'required_int64_group': 1, + 'string_group': "string_group_example", + 'int64_group': 1, + } + header_params = { + 'required_boolean_group': "true", + 'boolean_group': "true", + } + try: + # Fake endpoint to test group parameters (optional) + api_response = api_instance.group_parameters( + query_params=query_params, + header_params=header_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->group_parameters: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake/get.md new file mode 100644 index 00000000000..445e96a7c1a --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake/get.md @@ -0,0 +1,275 @@ +petstore_api.paths.fake.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| enum_parameters | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | Fake | This api is only for path=/fake | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | To test enum parameters | +| Description | To test enum parameters | +| Path | "/fake" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | +content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) + +#### RequestBody content ApplicationXWwwFormUrlencoded Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**enum_form_string_array** | list, tuple | [properties.EnumFormStringArray](#requestbody-content-applicationxwwwformurlencoded-schema-properties-enumformstringarray) | Form parameter enum test (string array) | [optional] +**enum_form_string** | str | str | Form parameter enum test (string) | [optional] must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +#### RequestBody content ApplicationXWwwFormUrlencoded Schema properties EnumFormStringArray + +##### Description +Form parameter enum test (string array) + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | Form parameter enum test (string array) | + +##### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +enum_query_string_array | [Parameter2.schema](#parameter2-schema), list, tuple | | optional +enum_query_string | [Parameter3.schema](#parameter3-schema), str | | optional +enum_query_integer | [Parameter4.schema](#parameter4-schema), decimal.Decimal, int | | optional +enum_query_double | [Parameter5.schema](#parameter5-schema), decimal.Decimal, int, float | | optional + + +#### Parameter2 + +##### Description +Query parameter enum test (string array) + +##### Parameter2 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ + +#### Parameter3 + +##### Description +Query parameter enum test (string) + +##### Parameter3 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg + +#### Parameter4 + +##### Description +Query parameter enum test (double) + +##### Parameter4 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | must be one of [1, -2] value must be a 32 bit integer + +#### Parameter5 + +##### Description +Query parameter enum test (double) + +##### Parameter5 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int, float | decimal.Decimal | | must be one of [1.1, -1.2] value must be a 64 bit float + +### header_params +#### RequestHeaderParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +enum_header_string_array | [Parameter0.schema](#parameter0-schema), list, tuple | | optional +enum_header_string | [Parameter1.schema](#parameter1-schema), str | | optional + + +#### Parameter0 + +##### Description +Header parameter enum test (string array) + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | must be one of [">", "$"] if omitted the server will use the default value of $ + +#### Parameter1 + +##### Description +Header parameter enum test (string) + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | must be one of ["_abc", "-efg", "(xyz)"] if omitted the server will use the default value of -efg + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Not found + +## ResponseFor404 + +### Description +Not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor404-body) | [content.application_json.schema](#responsefor404-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor404 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor404-content-applicationjson-schema) + +### Body Details +#### ResponseFor404 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + query_params = { + 'enum_query_string_array': [ + "$" + ], + 'enum_query_string': "-efg", + 'enum_query_integer': 1, + 'enum_query_double': 1.1, + } + header_params = { + 'enum_header_string_array': [ + "$" + ], + 'enum_header_string': "-efg", + } + body = dict( + enum_form_string_array=[ + "$" + ], + enum_form_string="-efg", + ) + try: + # To test enum parameters + api_response = api_instance.enum_parameters( + query_params=query_params, + header_params=header_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->enum_parameters: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake/patch.md b/samples/openapi3/client/petstore/python/docs/paths/fake/patch.md new file mode 100644 index 00000000000..ca973ba30ee --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake/patch.md @@ -0,0 +1,113 @@ +petstore_api.paths.fake.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| client_model | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| patch | ApiForPatch | This api is only for this endpoint | +| patch | Fake | This api is only for path=/fake | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | To test \"client\" model | +| Description | To test \"client\" model | +| Path | "/fake" | +| HTTP Method | patch | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Client](../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + body = client.Client( + client="client_example", + ) + try: + # To test \"client\" model + api_response = api_instance.client_model( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->client_model: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake/post.md new file mode 100644 index 00000000000..b6bedb14c61 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake/post.md @@ -0,0 +1,173 @@ +petstore_api.paths.fake.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| endpoint_parameters | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | Fake | This api is only for path=/fake | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | +| Description | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | +| Path | "/fake" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) + +#### RequestBody content ApplicationXWwwFormUrlencoded Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**byte** | str | str | None | +**double** | decimal.Decimal, int, float | decimal.Decimal | None | value must be a 64 bit float +**number** | decimal.Decimal, int, float | decimal.Decimal | None | +**pattern_without_delimiter** | str | str | None | +**integer** | decimal.Decimal, int | decimal.Decimal | None | [optional] +**int32** | decimal.Decimal, int | decimal.Decimal | None | [optional] value must be a 32 bit integer +**int64** | decimal.Decimal, int | decimal.Decimal | None | [optional] value must be a 64 bit integer +**float** | decimal.Decimal, int, float | decimal.Decimal | None | [optional] value must be a 32 bit float +**string** | str | str | None | [optional] +**binary** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | None | [optional] +**date** | str, datetime.date | str | None | [optional] value must conform to RFC-3339 full-date YYYY-MM-DD +**dateTime** | str, datetime.datetime | str | None | [optional] if omitted the server will use the default value of 2010-02-01T10:20:10.111110+01:00 value must conform to RFC-3339 date-time +**password** | str | str | None | [optional] +**callback** | str | str | None | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found + +## ResponseFor404 + +### Description +User not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["http_basic_test"](../../components/security_schemes/security_scheme_http_basic_test.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_http_basic_test + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( + user_id='someUserIdOrName', + password='somePassword', + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = dict( + integer=10, + int32=20, + int64=1, + number=32.1, + _float=3.14, + double=67.8, + string="A", + pattern_without_delimiter="AUR,rZ#UM/?R,Fp^l6$ARjbhJk C>", + byte='YQ==', + binary=open('/path/to/file', 'rb'), + date="1970-01-01", + date_time="2020-02-02T20:20:20.222220Z", + password="password_example", + callback="callback_example", + ) + try: + # Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + api_response = api_instance.endpoint_parameters( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->endpoint_parameters: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_additional_properties_with_array_of_enums/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_additional_properties_with_array_of_enums/get.md new file mode 100644 index 00000000000..24baaae5f43 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_additional_properties_with_array_of_enums/get.md @@ -0,0 +1,131 @@ +petstore_api.paths.fake_additional_properties_with_array_of_enums.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| additional_properties_with_array_of_enums | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeAdditionalPropertiesWithArrayOfEnums | This api is only for path=/fake/additional-properties-with-array-of-enums | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Additional Properties with Array of Enums | +| Path | "/fake/additional-properties-with-array-of-enums" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input enum + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalPropertiesWithArrayOfEnums](../../components/schema/additional_properties_with_array_of_enums.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Got object with additional properties with array of enums + +## ResponseFor200 + +### Description +Got object with additional properties with array of enums + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AdditionalPropertiesWithArrayOfEnums](../../components/schema/additional_properties_with_array_of_enums.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = additional_properties_with_array_of_enums.AdditionalPropertiesWithArrayOfEnums( + key=[ + enum_class.EnumClass("-efg") + ], + ) + try: + # Additional Properties with Array of Enums + api_response = api_instance.additional_properties_with_array_of_enums( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->additional_properties_with_array_of_enums: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_file_schema/put.md b/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_file_schema/put.md new file mode 100644 index 00000000000..3e7d1a25613 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_file_schema/put.md @@ -0,0 +1,104 @@ +petstore_api.paths.fake_body_with_file_schema.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| body_with_file_schema | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| put | ApiForPut | This api is only for this endpoint | +| put | FakeBodyWithFileSchema | This api is only for path=/fake/body-with-file-schema | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | For this test, the body for this request much reference a schema named `File`. | +| Path | "/fake/body-with-file-schema" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[FileSchemaTestClass](../../components/schema/file_schema_test_class.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + body = file_schema_test_class.FileSchemaTestClass( + file=file.File( + source_uri="source_uri_example", + ), + files=[ + file.File() + ], + ) + try: + api_response = api_instance.body_with_file_schema( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->body_with_file_schema: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_query_params/put.md b/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_query_params/put.md new file mode 100644 index 00000000000..e9cfa1a6308 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_body_with_query_params/put.md @@ -0,0 +1,133 @@ +petstore_api.paths.fake_body_with_query_params.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| body_with_query_params | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| put | ApiForPut | This api is only for this endpoint | +| put | FakeBodyWithQueryParams | This api is only for path=/fake/body-with-query-params | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/fake/body-with-query-params" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[User](../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +query | [Parameter0.schema](#parameter0-schema), str | | + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'query': "query_example", + } + body = user.User( + id=1, + username="username_example", + first_name="first_name_example", + last_name="last_name_example", + email="email_example", + password="password_example", + phone="phone_example", + user_status=1, + object_with_no_declared_props=dict(), + object_with_no_declared_props_nullable=dict(), + any_type_prop=None, + any_type_except_null_prop=None, + any_type_prop_nullable=None, + ) + try: + api_response = api_instance.body_with_query_params( + query_params=query_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->body_with_query_params: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_case_sensitive_params/put.md b/samples/openapi3/client/petstore/python/docs/paths/fake_case_sensitive_params/put.md new file mode 100644 index 00000000000..03c094a9f2f --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_case_sensitive_params/put.md @@ -0,0 +1,124 @@ +petstore_api.paths.fake_case_sensitive_params.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| case_sensitive_params | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| put | ApiForPut | This api is only for this endpoint | +| put | FakeCaseSensitiveParams | This api is only for path=/fake/case-sensitive-params | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Ensures that original naming is used in endpoint params, that way we on't have collisions | +| Path | "/fake/case-sensitive-params" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +someVar | [Parameter0.schema](#parameter0-schema), str | | +SomeVar | [Parameter1.schema](#parameter1-schema), str | | +some_var | [Parameter2.schema](#parameter2-schema), str | | + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter1 + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter2 + +##### Parameter2 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'someVar': "someVar_example", + 'SomeVar': "SomeVar_example", + 'some_var': "some_var_example", + } + try: + api_response = api_instance.case_sensitive_params( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->case_sensitive_params: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_classname_test/patch.md b/samples/openapi3/client/petstore/python/docs/paths/fake_classname_test/patch.md new file mode 100644 index 00000000000..d3a64c8d3ef --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_classname_test/patch.md @@ -0,0 +1,139 @@ +petstore_api.paths.fake_classname_test.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| classname | [FakeClassnameTags123Api](../../apis/tags/fake_classname_tags123_api.md) | This api is only for tag=fake_classname_tags 123#$%^ | +| patch | ApiForPatch | This api is only for this endpoint | +| patch | FakeClassnameTest | This api is only for path=/fake_classname_test | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | To test class name in snake case | +| Description | To test class name in snake case | +| Path | "/fake_classname_test" | +| HTTP Method | patch | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_client.md) | typing.Union[[Client.content.application_json.schema](../../components/request_bodies/request_body_client.md#content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Client](../../components/schema/client.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key_query"](../../components/security_schemes/security_scheme_api_key_query.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_classname_tags123_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key_query + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key_query": security_scheme_api_key_query.ApiKeyQuery( + api_key='sampleApiKeyValue' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_classname_tags123_api.FakeClassnameTags123Api(api_client) + + # example passing only required values which don't have defaults set + body = client.Client( + client="client_example", + ) + try: + # To test class name in snake case + api_response = api_instance.classname( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeClassnameTags123Api->classname: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeClassnameTags123Api API]](../../apis/tags/fake_classname_tags123_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_delete_coffee_id/delete.md b/samples/openapi3/client/petstore/python/docs/paths/fake_delete_coffee_id/delete.md new file mode 100644 index 00000000000..b638d2c7c5b --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_delete_coffee_id/delete.md @@ -0,0 +1,120 @@ +petstore_api.paths.fake_delete_coffee_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| delete_coffee | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| delete | ApiForDelete | This api is only for this endpoint | +| delete | FakeDeleteCoffeeId | This api is only for path=/fake/deleteCoffee/{id} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Delete coffee | +| Description | Delete the coffee identified by the given id, (delete without request body) | +| Path | "/fake/deleteCoffee/{id}" | +| HTTP Method | delete | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +id | [Parameter0.schema](#parameter0-schema), str | | + + +#### Parameter0 + +##### Description +The internal object id + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [Default.response_cls](#default-response_cls) | Unexpected error +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Default + +### Description +Unexpected error + +### Default response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'id': "id_example", + } + try: + # Delete coffee + api_response = api_instance.delete_coffee( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->delete_coffee: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_health/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_health/get.md new file mode 100644 index 00000000000..d30de68da64 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_health/get.md @@ -0,0 +1,105 @@ +petstore_api.paths.fake_health.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| fake_health_get | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeHealth | This api is only for path=/fake/health | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Health check endpoint | +| Path | "/fake/health" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | The instance started successfully + +## ResponseFor200 + +### Description +The instance started successfully + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[HealthCheckResult](../../components/schema/health_check_result.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Health check endpoint + api_response = api_instance.fake_health_get() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->fake_health_get: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_inline_additional_properties/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_inline_additional_properties/post.md new file mode 100644 index 00000000000..a9afc5f8187 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_inline_additional_properties/post.md @@ -0,0 +1,108 @@ +petstore_api.paths.fake_inline_additional_properties.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| inline_additional_properties | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeInlineAdditionalProperties | This api is only for path=/fake/inline-additionalProperties | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | test inline additionalProperties | +| Path | "/fake/inline-additionalProperties" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +request body + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**any_string_name** | str | str | any string name can be used but the value must be the correct type | [optional] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + body = dict( + "key": "key_example", + ) + try: + # test inline additionalProperties + api_response = api_instance.inline_additional_properties( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->inline_additional_properties: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_inline_composition/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_inline_composition/post.md new file mode 100644 index 00000000000..cd203a70923 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_inline_composition/post.md @@ -0,0 +1,295 @@ +petstore_api.paths.fake_inline_composition.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| inline_composition | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeInlineComposition | This api is only for path=/fake/inlineComposition/ | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | testing composed schemas at inline locations | +| Description | composed schemas at inline locations + multiple requestBody content types | +| Path | "/fake/inlineComposition/" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), [RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", "multipart/form-data", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +multiple content types + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) +"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +##### Composed Schemas (allOf/anyOf/oneOf/not) +##### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#requestbody-content-applicationjson-schema-allof-_0) | str | str | | + +#### RequestBody content ApplicationJson Schema allof _0 + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | +#### RequestBody content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#requestbody-content-multipartformdata-schema-properties-someprop) | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +#### RequestBody content MultipartFormData Schema properties SomeProp + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +##### Composed Schemas (allOf/anyOf/oneOf/not) +##### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#requestbody-content-multipartformdata-schema-properties-someprop-allof-_0) | str | str | | + +#### RequestBody content MultipartFormData Schema properties SomeProp allof _0 + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +compositionAtRoot | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | optional +compositionInProperty | [Parameter1.schema](#parameter1-schema), dict, frozendict.frozendict | | optional + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +###### Composed Schemas (allOf/anyOf/oneOf/not) +###### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#parameter0-schema-allof-_0) | str | str | | + +##### Parameter0 Schema allof _0 + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter1 + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +###### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#parameter1-schema-properties-someprop) | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +##### Parameter1 Schema properties SomeProp + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +###### Composed Schemas (allOf/anyOf/oneOf/not) +###### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#parameter1-schema-properties-someprop-allof-_0) | str | str | | + +##### Parameter1 Schema properties SomeProp allof _0 + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success, multiple content types + +## ResponseFor200 + +### Description +success, multiple content types + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_json.schema](#responsefor200-content-applicationjson-schema), [content.multipart_form_data.schema](#responsefor200-content-multipartformdata-schema)] | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) +"multipart/form-data" | [content.multipart_form_data.Schema](#responsefor200-content-multipartformdata-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +##### Composed Schemas (allOf/anyOf/oneOf/not) +##### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#responsefor200-content-applicationjson-schema-allof-_0) | str | str | | + +#### ResponseFor200 content ApplicationJson Schema allof _0 + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | +#### ResponseFor200 content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**someProp** | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | [properties.SomeProp](#responsefor200-content-multipartformdata-schema-properties-someprop) | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +#### ResponseFor200 content MultipartFormData Schema properties SomeProp + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +##### Composed Schemas (allOf/anyOf/oneOf/not) +##### allOf +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +[_0](#responsefor200-content-multipartformdata-schema-properties-someprop-allof-_0) | str | str | | + +#### ResponseFor200 content MultipartFormData Schema properties SomeProp allof _0 + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + query_params = { + 'compositionAtRoot': None, + 'compositionInProperty': dict( + some_prop=None, + ), + } + body = None + try: + # testing composed schemas at inline locations + api_response = api_instance.inline_composition( + query_params=query_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->inline_composition: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_json_form_data/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_json_form_data/get.md new file mode 100644 index 00000000000..052d98b638b --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_json_form_data/get.md @@ -0,0 +1,108 @@ +petstore_api.paths.fake_json_form_data.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| json_form_data | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeJsonFormData | This api is only for path=/fake/jsonFormData | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | test json serialization of form data | +| Path | "/fake/jsonFormData" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) + +#### RequestBody content ApplicationXWwwFormUrlencoded Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**param** | str | str | field1 | +**param2** | str | str | field2 | +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = dict( + param="param_example", + param2="param2_example", + ) + try: + # test json serialization of form data + api_response = api_instance.json_form_data( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->json_form_data: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_json_patch/patch.md b/samples/openapi3/client/petstore/python/docs/paths/fake_json_patch/patch.md new file mode 100644 index 00000000000..ed582731514 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_json_patch/patch.md @@ -0,0 +1,101 @@ +petstore_api.paths.fake_json_patch.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| json_patch | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| patch | ApiForPatch | This api is only for this endpoint | +| patch | FakeJsonPatch | This api is only for path=/fake/jsonPatch | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | json patch | +| Description | json patch route with a requestBody | +| Path | "/fake/jsonPatch" | +| HTTP Method | patch | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json_patchjson.schema](#RequestBody-content-applicationjsonpatchjson-schema), Unset, list, tuple] | optional, default is unset | +content_type | str | optional, default is 'application/json-patch+json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json-patch+json" | [content.application_json_patchjson.Schema](#requestbody-content-applicationjsonpatchjson-schema) + +#### RequestBody content ApplicationJsonPatchjson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[JSONPatchRequest](../../components/schema/json_patch_request.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = json_patch_request.JSONPatchRequest([ + None + ]) + try: + # json patch + api_response = api_instance.json_patch( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->json_patch: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_json_with_charset/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_json_with_charset/post.md new file mode 100644 index 00000000000..1c048375286 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_json_with_charset/post.md @@ -0,0 +1,124 @@ +petstore_api.paths.fake_json_with_charset.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| json_with_charset | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeJsonWithCharset | This api is only for path=/fake/jsonWithCharset | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | json with charset tx and rx | +| Path | "/fake/jsonWithCharset" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json_charsetutf8.schema](#RequestBody-content-applicationjsoncharsetutf8-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | +content_type | str | optional, default is 'application/json; charset=utf-8' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json; charset=utf-8", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json; charset=utf-8" | [content.application_json_charsetutf8.Schema](#requestbody-content-applicationjsoncharsetutf8-schema) + +#### RequestBody content ApplicationJsonCharsetutf8 Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json_charsetutf8.schema](#responsefor200-content-applicationjsoncharsetutf8-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json; charset=utf-8" | [content.application_json_charsetutf8.Schema](#responsefor200-content-applicationjsoncharsetutf8-schema) + +### Body Details +#### ResponseFor200 content ApplicationJsonCharsetutf8 Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = None + try: + # json with charset tx and rx + api_response = api_instance.json_with_charset( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->json_with_charset: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_response_bodies/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_response_bodies/get.md new file mode 100644 index 00000000000..2a0004d4675 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_response_bodies/get.md @@ -0,0 +1,131 @@ +petstore_api.paths.fake_multiple_response_bodies.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| multiple_response_bodies | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeMultipleResponseBodies | This api is only for path=/fake/multipleResponseBodies | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | multiple responses have response bodies | +| Path | "/fake/multipleResponseBodies" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success +202 | [ResponseFor202.response_cls](#responsefor202-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## ResponseFor202 + +### Description +success + +### ResponseFor202 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor202-body) | [content.application_json.schema](#responsefor202-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor202 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor202-content-applicationjson-schema) + +### Body Details +#### ResponseFor202 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # multiple responses have response bodies + api_response = api_instance.multiple_response_bodies() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->multiple_response_bodies: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_securities/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_securities/get.md new file mode 100644 index 00000000000..ba9653f9e33 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_multiple_securities/get.md @@ -0,0 +1,152 @@ +petstore_api.paths.fake_multiple_securities.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| multiple_securities | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeMultipleSecurities | This api is only for path=/fake/multipleSecurities | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | multiple security requirements | +| Path | "/fake/multipleSecurities" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | no security | +| 1 | ["http_basic_test"](../../components/security_schemes/security_scheme_http_basic_test.md) []
["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 2 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_http_basic_test +from petstore_api.components.security_schemes import security_scheme_api_key +# security_index 2 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +# no auth required for this security_index +security_scheme_info: api_configuration.SecuritySchemeInfo = {} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_basic_test": security_scheme_http_basic_test.HttpBasicTest( + user_id='someUserIdOrName', + password='somePassword', + ), + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 2 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # multiple security requirements + api_response = api_instance.multiple_securities() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->multiple_securities: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_obj_in_query/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_obj_in_query/get.md new file mode 100644 index 00000000000..08b4c974b19 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_obj_in_query/get.md @@ -0,0 +1,114 @@ +petstore_api.paths.fake_obj_in_query.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| object_in_query | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeObjInQuery | This api is only for path=/fake/objInQuery | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | user list | +| Path | "/fake/objInQuery" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +mapBean | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict | | optional + + +#### Parameter0 + +##### Description +mapBean + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +###### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**keyword** | str | str | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + query_params = { + 'mapBean': dict( + keyword="keyword_example", + ), + } + try: + # user list + api_response = api_instance.object_in_query( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->object_in_query: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_parameter_collisions1_abab_self_ab/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_parameter_collisions1_abab_self_ab/post.md new file mode 100644 index 00000000000..854ef458d37 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_parameter_collisions1_abab_self_ab/post.md @@ -0,0 +1,407 @@ +petstore_api.paths.fake_parameter_collisions1_abab_self_ab.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| parameter_collisions | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeParameterCollisions1ABAbSelfAB | This api is only for path=/fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/ | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | parameter collision case | +| Path | "/fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +[cookie_params](#cookie-params) | [RequestCookieParameters.Params](#requestcookieparametersparams), dict | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +1 | [Parameter0.schema](#parameter0-schema), str | | optional +aB | [Parameter1.schema](#parameter1-schema), str | | optional +Ab | [Parameter2.schema](#parameter2-schema), str | | optional +self | [Parameter3.schema](#parameter3-schema), str | | optional +A-B | [Parameter4.schema](#parameter4-schema), str | | optional + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter1 + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter2 + +##### Parameter2 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter3 + +##### Parameter3 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter4 + +##### Parameter4 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### header_params +#### RequestHeaderParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +1 | [Parameter5.schema](#parameter5-schema), str | | optional +aB | [Parameter6.schema](#parameter6-schema), str | | optional +self | [Parameter7.schema](#parameter7-schema), str | | optional +A-B | [Parameter8.schema](#parameter8-schema), str | | optional + + +#### Parameter5 + +##### Parameter5 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter6 + +##### Parameter6 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter7 + +##### Parameter7 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter8 + +##### Parameter8 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +1 | [Parameter9.schema](#parameter9-schema), str | | +aB | [Parameter10.schema](#parameter10-schema), str | | +Ab | [Parameter11.schema](#parameter11-schema), str | | +self | [Parameter12.schema](#parameter12-schema), str | | +A-B | [Parameter13.schema](#parameter13-schema), str | | + + +#### Parameter9 + +##### Parameter9 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter10 + +##### Parameter10 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter11 + +##### Parameter11 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter12 + +##### Parameter12 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter13 + +##### Parameter13 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### cookie_params +#### RequestCookieParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +1 | [Parameter14.schema](#parameter14-schema), str | | optional +aB | [Parameter15.schema](#parameter15-schema), str | | optional +Ab | [Parameter16.schema](#parameter16-schema), str | | optional +self | [Parameter17.schema](#parameter17-schema), str | | optional +A-B | [Parameter18.schema](#parameter18-schema), str | | optional + + +#### Parameter14 + +##### Parameter14 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter15 + +##### Parameter15 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter16 + +##### Parameter16 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter17 + +##### Parameter17 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter18 + +##### Parameter18 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + '1': "1_example", + 'aB': "aB_example", + 'Ab': "Ab_example", + 'self': "self_example", + 'A-B': "A-B_example", + } + query_params = { + } + cookie_params = { + } + header_params = { + } + try: + # parameter collision case + api_response = api_instance.parameter_collisions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + cookie_params=cookie_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->parameter_collisions: %s\n" % e) + + # example passing only optional values + path_params = { + '1': "1_example", + 'aB': "aB_example", + 'Ab': "Ab_example", + 'self': "self_example", + 'A-B': "A-B_example", + } + query_params = { + '1': "1_example", + 'aB': "aB_example", + 'Ab': "Ab_example", + 'self': "self_example", + 'A-B': "A-B_example", + } + cookie_params = { + '1': "1_example", + 'aB': "aB_example", + 'Ab': "Ab_example", + 'self': "self_example", + 'A-B': "A-B_example", + } + header_params = { + '1': "1_example", + 'aB': "aB_example", + 'self': "self_example", + 'A-B': "A-B_example", + } + body = None + try: + # parameter collision case + api_response = api_instance.parameter_collisions( + path_params=path_params, + query_params=query_params, + header_params=header_params, + cookie_params=cookie_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->parameter_collisions: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_pet_id_upload_image_with_required_file/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_pet_id_upload_image_with_required_file/post.md new file mode 100644 index 00000000000..74ff2d11c98 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_pet_id_upload_image_with_required_file/post.md @@ -0,0 +1,198 @@ +petstore_api.paths.fake_pet_id_upload_image_with_required_file.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| upload_file_with_required_file | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| post | ApiForPost | This api is only for this endpoint | +| post | FakePetIdUploadImageWithRequiredFile | This api is only for path=/fake/{petId}/uploadImageWithRequiredFile | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | uploads an image (required) | +| Path | "/fake/{petId}/uploadImageWithRequiredFile" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) + +#### RequestBody content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**requiredFile** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | +**additionalMetadata** | str | str | Additional data to pass to server | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | + + +#### Parameter0 + +##### Description +ID of pet to update + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ApiResponse](../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'petId': 1, + } + try: + # uploads an image (required) + api_response = api_instance.upload_file_with_required_file( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->upload_file_with_required_file: %s\n" % e) + + # example passing only optional values + path_params = { + 'petId': 1, + } + body = dict( + additional_metadata="additional_metadata_example", + required_file=open('/path/to/file', 'rb'), + ) + try: + # uploads an image (required) + api_response = api_instance.upload_file_with_required_file( + path_params=path_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->upload_file_with_required_file: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_query_param_with_json_content_type/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_query_param_with_json_content_type/get.md new file mode 100644 index 00000000000..e3b7d1dc8c5 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_query_param_with_json_content_type/get.md @@ -0,0 +1,136 @@ +petstore_api.paths.fake_query_param_with_json_content_type.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| query_param_with_json_content_type | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeQueryParamWithJsonContentType | This api is only for path=/fake/queryParamWithJsonContentType | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | query param with json content-type | +| Path | "/fake/queryParamWithJsonContentType" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +someParam | [Parameter0.content.application_json.schema](#parameter0-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 | | + + +#### Parameter0 + +##### Description +The internal object id + +##### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#parameter0-content-applicationjson-schema) +##### Parameter0 content ApplicationJson Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | success + +## ResponseFor200 + +### Description +success + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'someParam': , + } + try: + # query param with json content-type + api_response = api_instance.query_param_with_json_content_type( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->query_param_with_json_content_type: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_ref_obj_in_query/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_ref_obj_in_query/get.md new file mode 100644 index 00000000000..fd0f2812b51 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_ref_obj_in_query/get.md @@ -0,0 +1,108 @@ +petstore_api.paths.fake_ref_obj_in_query.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| ref_object_in_query | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeRefObjInQuery | This api is only for path=/fake/refObjInQuery | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | user list | +| Path | "/fake/refObjInQuery" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +mapBean | [Parameter0.schema](#parameter0-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | optional + + +#### Parameter0 + +##### Description +mapBean + +##### Parameter0 Schema + +###### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Foo](../../components/schema/foo.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + query_params = { + 'mapBean': foo.Foo( + bar=bar.Bar("bar"), + ), + } + try: + # user list + api_response = api_instance.ref_object_in_query( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->ref_object_in_query: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_array_of_enums/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_array_of_enums/post.md new file mode 100644 index 00000000000..3e24d3a4a06 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_array_of_enums/post.md @@ -0,0 +1,129 @@ +petstore_api.paths.fake_refs_array_of_enums.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| array_of_enums | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsArrayOfEnums | This api is only for path=/fake/refs/array-of-enums | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Array of Enums | +| Path | "/fake/refs/array-of-enums" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, list, tuple] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input enum + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ArrayOfEnums](../../components/schema/array_of_enums.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Got named array of enums + +## ResponseFor200 + +### Description +Got named array of enums + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ArrayOfEnums](../../components/schema/array_of_enums.md) | list, tuple | tuple | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = array_of_enums.ArrayOfEnums([ + string_enum.StringEnum("string_example") + ]) + try: + # Array of Enums + api_response = api_instance.array_of_enums( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->array_of_enums: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_arraymodel/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_arraymodel/post.md new file mode 100644 index 00000000000..40cbe47e6ce --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_arraymodel/post.md @@ -0,0 +1,128 @@ +petstore_api.paths.fake_refs_arraymodel.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| array_model | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsArraymodel | This api is only for path=/fake/refs/arraymodel | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of ArrayModel | +| Path | "/fake/refs/arraymodel" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, list, tuple] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input model + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnimalFarm](../../components/schema/animal_farm.md) | list, tuple | tuple | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model + +## ResponseFor200 + +### Description +Output model + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[AnimalFarm](../../components/schema/animal_farm.md) | list, tuple | tuple | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = animal_farm.AnimalFarm([ + animal.Animal() + ]) + try: + api_response = api_instance.array_model( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->array_model: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_boolean/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_boolean/post.md new file mode 100644 index 00000000000..d125ae008ab --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_boolean/post.md @@ -0,0 +1,126 @@ +petstore_api.paths.fake_refs_boolean.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| boolean | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsBoolean | This api is only for path=/fake/refs/boolean | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of outer boolean types | +| Path | "/fake/refs/boolean" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, bool] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input boolean as post body + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Boolean](../../components/schema/boolean.md) | bool | BoolClass | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output boolean + +## ResponseFor200 + +### Description +Output boolean + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Boolean](../../components/schema/boolean.md) | bool | BoolClass | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = boolean.Boolean(True) + try: + api_response = api_instance.boolean( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->boolean: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_composed_one_of_number_with_validations/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_composed_one_of_number_with_validations/post.md new file mode 100644 index 00000000000..f44b91177d6 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_composed_one_of_number_with_validations/post.md @@ -0,0 +1,126 @@ +petstore_api.paths.fake_refs_composed_one_of_number_with_validations.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| composed_one_of_different_types | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsComposedOneOfNumberWithValidations | This api is only for path=/fake/refs/composed_one_of_number_with_validations | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of object with $refed properties | +| Path | "/fake/refs/composed_one_of_number_with_validations" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input model + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ComposedOneOfDifferentTypes](../../components/schema/composed_one_of_different_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model + +## ResponseFor200 + +### Description +Output model + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ComposedOneOfDifferentTypes](../../components/schema/composed_one_of_different_types.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = composed_one_of_different_types.ComposedOneOfDifferentTypes(None) + try: + api_response = api_instance.composed_one_of_different_types( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->composed_one_of_different_types: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_enum/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_enum/post.md new file mode 100644 index 00000000000..7a70c863235 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_enum/post.md @@ -0,0 +1,126 @@ +petstore_api.paths.fake_refs_enum.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| string_enum | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsEnum | This api is only for path=/fake/refs/enum | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of outer enum | +| Path | "/fake/refs/enum" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, None, str] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input enum + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[StringEnum](../../components/schema/string_enum.md) | None, str | NoneClass, str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output enum + +## ResponseFor200 + +### Description +Output enum + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[StringEnum](../../components/schema/string_enum.md) | None, str | NoneClass, str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = string_enum.StringEnum("placed") + try: + api_response = api_instance.string_enum( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->string_enum: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_mammal/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_mammal/post.md new file mode 100644 index 00000000000..b1109f5c603 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_mammal/post.md @@ -0,0 +1,130 @@ +petstore_api.paths.fake_refs_mammal.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| mammal | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsMammal | This api is only for path=/fake/refs/mammal | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of mammals | +| Path | "/fake/refs/mammal" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[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 | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input mammal + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Mammal](../../components/schema/mammal.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output mammal + +## ResponseFor200 + +### Description +Output mammal + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Mammal](../../components/schema/mammal.md) | dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, io.FileIO | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + body = mammal.Mammal( + has_baleen=True, + has_teeth=True, + class_name="whale", + ) + try: + api_response = api_instance.mammal( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->mammal: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_number/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_number/post.md new file mode 100644 index 00000000000..f9c1ed596ea --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_number/post.md @@ -0,0 +1,126 @@ +petstore_api.paths.fake_refs_number.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| number_with_validations | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsNumber | This api is only for path=/fake/refs/number | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of outer number types | +| Path | "/fake/refs/number" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, decimal.Decimal, int, float] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input number as post body + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NumberWithValidations](../../components/schema/number_with_validations.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output number + +## ResponseFor200 + +### Description +Output number + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[NumberWithValidations](../../components/schema/number_with_validations.md) | decimal.Decimal, int, float | decimal.Decimal | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = number_with_validations.NumberWithValidations(10) + try: + api_response = api_instance.number_with_validations( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->number_with_validations: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_object_model_with_ref_props/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_object_model_with_ref_props/post.md new file mode 100644 index 00000000000..bf42fa98151 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_object_model_with_ref_props/post.md @@ -0,0 +1,130 @@ +petstore_api.paths.fake_refs_object_model_with_ref_props.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| object_model_with_ref_props | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsObjectModelWithRefProps | This api is only for path=/fake/refs/object_model_with_ref_props | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of object with $refed properties | +| Path | "/fake/refs/object_model_with_ref_props" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input model + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectModelWithRefProps](../../components/schema/object_model_with_ref_props.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output model + +## ResponseFor200 + +### Description +Output model + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ObjectModelWithRefProps](../../components/schema/object_model_with_ref_props.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = object_model_with_ref_props.ObjectModelWithRefProps( + my_number=number_with_validations.NumberWithValidations(10), + my_string=string.String("my_string_example"), + my_boolean=boolean.Boolean(True), + ) + try: + api_response = api_instance.object_model_with_ref_props( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->object_model_with_ref_props: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_refs_string/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_string/post.md new file mode 100644 index 00000000000..94bb952e2de --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_refs_string/post.md @@ -0,0 +1,126 @@ +petstore_api.paths.fake_refs_string.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| string | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeRefsString | This api is only for path=/fake/refs/string | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | Test serialization of outer string types | +| Path | "/fake/refs/string" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), Unset, str] | optional, default is unset | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Input string as post body + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[String](../../components/schema/string.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | Output string + +## ResponseFor200 + +### Description +Output string + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[String](../../components/schema/string.md) | str | str | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = string.String("string_example") + try: + api_response = api_instance.string( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->string: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_response_without_schema/get.md b/samples/openapi3/client/petstore/python/docs/paths/fake_response_without_schema/get.md new file mode 100644 index 00000000000..bdbc5a9a9b0 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_response_without_schema/get.md @@ -0,0 +1,98 @@ +petstore_api.paths.fake_response_without_schema.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| response_without_schema | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| get | ApiForGet | This api is only for this endpoint | +| get | FakeResponseWithoutSchema | This api is only for path=/fake/responseWithoutSchema | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | receives a response without schema | +| Path | "/fake/responseWithoutSchema" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", "application/xml", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | contents without schema definition, multiple content types + +## ResponseFor200 + +### Description +contents without schema definition, multiple content types + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | Unset | body was not defined | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | no schema defined +"application/xml" | no schema defined + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # receives a response without schema + api_response = api_instance.response_without_schema() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->response_without_schema: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_test_query_paramters/put.md b/samples/openapi3/client/petstore/python/docs/paths/fake_test_query_paramters/put.md new file mode 100644 index 00000000000..3056cbaf06f --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_test_query_paramters/put.md @@ -0,0 +1,192 @@ +petstore_api.paths.fake_test_query_paramters.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| query_parameter_collection_format | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| put | ApiForPut | This api is only for this endpoint | +| put | FakeTestQueryParamters | This api is only for path=/fake/test-query-paramters | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Description | To test the collection format in query parameters | +| Path | "/fake/test-query-paramters" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +pipe | [Parameter0.schema](#parameter0-schema), list, tuple | | +ioutil | [Parameter1.schema](#parameter1-schema), list, tuple | | +http | [Parameter2.schema](#parameter2-schema), list, tuple | | +url | [Parameter3.schema](#parameter3-schema), list, tuple | | +context | [Parameter4.schema](#parameter4-schema), list, tuple | | +refParam | [Parameter5.schema](#parameter5-schema), dict, frozendict.frozendict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader | | + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +#### Parameter1 + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +#### Parameter2 + +##### Parameter2 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +#### Parameter3 + +##### Parameter3 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +#### Parameter4 + +##### Parameter4 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +#### Parameter5 + +##### Parameter5 Schema + +###### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[StringWithValidation](../../components/schema/string_with_validation.md) | str | str | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'pipe': [ + "pipe_example" + ], + 'ioutil': [ + "ioutil_example" + ], + 'http': [ + "http_example" + ], + 'url': [ + "url_example" + ], + 'context': [ + "context_example" + ], + 'refParam': string_with_validation.StringWithValidation("refParam_example"), + } + try: + api_response = api_instance.query_parameter_collection_format( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->query_parameter_collection_format: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_upload_download_file/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_download_file/post.md new file mode 100644 index 00000000000..dff03f573f6 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_download_file/post.md @@ -0,0 +1,130 @@ +petstore_api.paths.fake_upload_download_file.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| upload_download_file | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeUploadDownloadFile | This api is only for path=/fake/uploadDownloadFile | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | uploads a file and downloads a file using application/octet-stream | +| Path | "/fake/uploadDownloadFile" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_octet_stream.schema](#RequestBody-content-applicationoctetstream-schema), bytes, io.FileIO, io.BufferedReader] | required | +content_type | str | optional, default is 'application/octet-stream' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/octet-stream", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/octet-stream" | [content.application_octet_stream.Schema](#requestbody-content-applicationoctetstream-schema) + +#### RequestBody content ApplicationOctetStream Schema + +##### Description +file to upload + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_octet_stream.schema](#responsefor200-content-applicationoctetstream-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/octet-stream" | [content.application_octet_stream.Schema](#responsefor200-content-applicationoctetstream-schema) + +### Body Details +#### ResponseFor200 content ApplicationOctetStream Schema + +##### Description +file to download + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to download | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only required values which don't have defaults set + body = open('/path/to/file', 'rb') + try: + # uploads a file and downloads a file using application/octet-stream + api_response = api_instance.upload_download_file( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->upload_download_file: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_upload_file/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_file/post.md new file mode 100644 index 00000000000..cff57bf920d --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_file/post.md @@ -0,0 +1,134 @@ +petstore_api.paths.fake_upload_file.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| upload_file | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeUploadFile | This api is only for path=/fake/uploadFile | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | uploads a file using multipart/form-data | +| Path | "/fake/uploadFile" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) + +#### RequestBody content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**file** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | +**additionalMetadata** | str | str | Additional data to pass to server | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ApiResponse](../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = dict( + additional_metadata="additional_metadata_example", + file=open('/path/to/file', 'rb'), + ) + try: + # uploads a file using multipart/form-data + api_response = api_instance.upload_file( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->upload_file: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/fake_upload_files/post.md b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_files/post.md new file mode 100644 index 00000000000..53e4d248912 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/fake_upload_files/post.md @@ -0,0 +1,146 @@ +petstore_api.paths.fake_upload_files.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| upload_files | [FakeApi](../../apis/tags/fake_api.md) | This api is only for tag=fake | +| post | ApiForPost | This api is only for this endpoint | +| post | FakeUploadFiles | This api is only for path=/fake/uploadFiles | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | uploads files using multipart/form-data | +| Path | "/fake/uploadFiles" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) + +#### RequestBody content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**files** | list, tuple | [properties.Files](#requestbody-content-multipartformdata-schema-properties-files) | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +#### RequestBody content MultipartFormData Schema properties Files + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +##### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | [content.application_json.schema](#responsefor200-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[ApiResponse](../../components/schema/api_response.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import fake_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = fake_api.FakeApi(api_client) + + # example passing only optional values + body = dict( + files=[ + open('/path/to/file', 'rb') + ], + ) + try: + # uploads files using multipart/form-data + api_response = api_instance.upload_files( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling FakeApi->upload_files: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to FakeApi API]](../../apis/tags/fake_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/foo/get.md b/samples/openapi3/client/petstore/python/docs/paths/foo/get.md new file mode 100644 index 00000000000..d44230891a2 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/foo/get.md @@ -0,0 +1,123 @@ +petstore_api.paths.foo.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| foo_get | [DefaultApi](../../apis/tags/default_api.md) | This api is only for tag=default | +| get | ApiForGet | This api is only for this endpoint | +| get | Foo | This api is only for path=/foo | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Path | "/foo" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [Default.response_cls](#default-response_cls) | response + +## Default + +### Description +response + +### Default response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#default-body) | [content.application_json.schema](#default-content-applicationjson-schema) | | +headers | Unset | headers were not defined | + +### Default Body +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#default-content-applicationjson-schema) + +### Body Details +#### Default content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**string** | [**Foo**](../../components/schema/foo.md), dict, frozendict.frozendict | [**Foo**](../../components/schema/foo.md) | | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are specific to this endpoint +- defaults to server_index=0, server.url = https://path-server-test.petstore.local/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](#server0) | +1 | [Server1](#server1) | + +### Server0 + +#### Url +https://path-server-test.petstore.local/v2 + +### Server1 + +#### Url +https://petstore.swagger.io/{version} + +#### Variables +Key | Type | Description | Notes +--- | ---- | ----------- | ------ +**version** | str | | must be one of ["v1", "v2"] if omitted the client will use the default value of v1 + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import default_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = default_api.DefaultApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + api_response = api_instance.foo_get() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling DefaultApi->foo_get: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to DefaultApi API]](../../apis/tags/default_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet/post.md b/samples/openapi3/client/petstore/python/docs/paths/pet/post.md new file mode 100644 index 00000000000..fdc1ef5d163 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet/post.md @@ -0,0 +1,179 @@ +petstore_api.paths.pet.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| add_pet | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| post | ApiForPost | This api is only for this endpoint | +| post | Pet | This api is only for path=/pet | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Add a new pet to the store | +| Description | Add a new pet to the store | +| Path | "/pet" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_pet.md) | typing.Union[[Pet.content.application_json.schema](../../components/request_bodies/request_body_pet.md#content-applicationjson-schema), [Pet.content.application_xml.schema](../../components/request_bodies/request_body_pet.md#content-applicationxml-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success +405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Invalid input + +## ResponseFor405 + +### Description +Invalid input + +### ResponseFor405 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["http_signature_test"](../../components/security_schemes/security_scheme_http_signature_test.md) []
| +| 2 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_http_signature_test +# security_index 2 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( + signing_info=petstore_api.signing.HttpSigningConfiguration( + key_id='my-key-id', + private_key_path='rsa.pem', + signing_scheme=petstore_api.signing.SCHEME_HS2019, + signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, + signed_headers=[ + petstore_api.signing.HEADER_REQUEST_TARGET, + petstore_api.signing.HEADER_CREATED, + petstore_api.signing.HEADER_EXPIRES, + petstore_api.signing.HEADER_HOST, + petstore_api.signing.HEADER_DATE, + petstore_api.signing.HEADER_DIGEST, + 'Content-Type', + 'User-Agent' + ], + signature_max_validity=datetime.timedelta(minutes=5) + ) + + ), +} + + +# security_scheme_info for security_index 2 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + body = pet.Pet( + id=1, + category=category.Category( + id=1, + name="default-name", + ), + name="doggie", + photo_urls=[ + "photo_urls_example" + ], + tags=[ + tag.Tag( + id=1, + name="name_example", + ) + ], + status="available", + ) + try: + # Add a new pet to the store + api_response = api_instance.add_pet( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->add_pet: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet/put.md b/samples/openapi3/client/petstore/python/docs/paths/pet/put.md new file mode 100644 index 00000000000..a308d90a253 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet/put.md @@ -0,0 +1,192 @@ +petstore_api.paths.pet.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| update_pet | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| put | ApiForPut | This api is only for this endpoint | +| put | Pet | This api is only for path=/pet | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Update an existing pet | +| Path | "/pet" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_pet.md) | typing.Union[[Pet.content.application_json.schema](../../components/request_bodies/request_body_pet.md#content-applicationjson-schema), [Pet.content.application_xml.schema](../../components/request_bodies/request_body_pet.md#content-applicationxml-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Pet not found +405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Validation exception + +## ResponseFor400 + +### Description +Invalid ID supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +Pet not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor405 + +### Description +Validation exception + +### ResponseFor405 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["http_signature_test"](../../components/security_schemes/security_scheme_http_signature_test.md) []
| +| 1 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_http_signature_test +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( + signing_info=petstore_api.signing.HttpSigningConfiguration( + key_id='my-key-id', + private_key_path='rsa.pem', + signing_scheme=petstore_api.signing.SCHEME_HS2019, + signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, + signed_headers=[ + petstore_api.signing.HEADER_REQUEST_TARGET, + petstore_api.signing.HEADER_CREATED, + petstore_api.signing.HEADER_EXPIRES, + petstore_api.signing.HEADER_HOST, + petstore_api.signing.HEADER_DATE, + petstore_api.signing.HEADER_DIGEST, + 'Content-Type', + 'User-Agent' + ], + signature_max_validity=datetime.timedelta(minutes=5) + ) + + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + body = pet.Pet( + id=1, + category=category.Category( + id=1, + name="default-name", + ), + name="doggie", + photo_urls=[ + "photo_urls_example" + ], + tags=[ + tag.Tag( + id=1, + name="name_example", + ) + ], + status="available", + ) + try: + # Update an existing pet + api_response = api_instance.update_pet( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->update_pet: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_status/get.md b/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_status/get.md new file mode 100644 index 00000000000..b38fdda373a --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_status/get.md @@ -0,0 +1,205 @@ +petstore_api.paths.pet_find_by_status.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| find_pets_by_status | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| get | ApiForGet | This api is only for this endpoint | +| get | PetFindByStatus | This api is only for path=/pet/findByStatus | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Finds Pets by status | +| Description | Multiple status values can be provided with comma separated strings | +| Path | "/pet/findByStatus" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +status | [Parameter0.schema](#parameter0-schema), list, tuple | | + + +#### Parameter0 + +##### Description +Status values that need to be considered for filter + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | must be one of ["available", "pending", "sold"] if omitted the server will use the default value of available + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessfulXmlAndJsonArrayOfPet.response_cls](../../components/responses/response_successful_xml_and_json_array_of_pet.md#response_successful_xml_and_json_array_of_petresponse_cls) | successful operation, multiple content types +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid status value + +## ResponseFor400 + +### Description +Invalid status value + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["http_signature_test"](../../components/security_schemes/security_scheme_http_signature_test.md) []
| +| 2 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are specific to this "/pet/findByStatus" path +- defaults to server_index=0, server.url = https://path-server-test.petstore.local/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](#server0) | +1 | [Server1](#server1) | + +### Server0 + +#### Url +https://path-server-test.petstore.local/v2 +### Server1 + +#### Url +https://petstore.swagger.io/{version} + +#### Variables +Key | Type | Description | Notes +--- | ---- | ----------- | ------ +**version** | str | | must be one of ["v1", "v2"] if omitted the client will use the default value of v1 + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_http_signature_test +# security_index 2 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( + signing_info=petstore_api.signing.HttpSigningConfiguration( + key_id='my-key-id', + private_key_path='rsa.pem', + signing_scheme=petstore_api.signing.SCHEME_HS2019, + signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, + signed_headers=[ + petstore_api.signing.HEADER_REQUEST_TARGET, + petstore_api.signing.HEADER_CREATED, + petstore_api.signing.HEADER_EXPIRES, + petstore_api.signing.HEADER_HOST, + petstore_api.signing.HEADER_DATE, + petstore_api.signing.HEADER_DIGEST, + 'Content-Type', + 'User-Agent' + ], + signature_max_validity=datetime.timedelta(minutes=5) + ) + + ), +} + + +# security_scheme_info for security_index 2 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'status': [ + "available" + ], + } + try: + # Finds Pets by status + api_response = api_instance.find_pets_by_status( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->find_pets_by_status: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_tags/get.md b/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_tags/get.md new file mode 100644 index 00000000000..43c5022e6e7 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_find_by_tags/get.md @@ -0,0 +1,180 @@ +petstore_api.paths.pet_find_by_tags.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| find_pets_by_tags | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| get | ApiForGet | This api is only for this endpoint | +| get | PetFindByTags | This api is only for path=/pet/findByTags | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Finds Pets by tags | +| Description | Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. | +| Path | "/pet/findByTags" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +tags | [Parameter0.schema](#parameter0-schema), list, tuple | | + + +#### Parameter0 + +##### Description +Tags to filter by + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +list, tuple | tuple | | + +###### List Items +Class Name | Input Type | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- | ------------- +items | str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [RefSuccessfulXmlAndJsonArrayOfPet.response_cls](../../components/responses/response_ref_successful_xml_and_json_array_of_pet.md#response_ref_successful_xml_and_json_array_of_petresponse_cls) | successful operation, multiple content types +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid tag value + +## ResponseFor400 + +### Description +Invalid tag value + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["http_signature_test"](../../components/security_schemes/security_scheme_http_signature_test.md) []
| +| 1 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_http_signature_test +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "http_signature_test": security_scheme_http_signature_test.HttpSignatureTest( + signing_info=petstore_api.signing.HttpSigningConfiguration( + key_id='my-key-id', + private_key_path='rsa.pem', + signing_scheme=petstore_api.signing.SCHEME_HS2019, + signing_algorithm=petstore_api.signing.ALGORITHM_RSASSA_PSS, + signed_headers=[ + petstore_api.signing.HEADER_REQUEST_TARGET, + petstore_api.signing.HEADER_CREATED, + petstore_api.signing.HEADER_EXPIRES, + petstore_api.signing.HEADER_HOST, + petstore_api.signing.HEADER_DATE, + petstore_api.signing.HEADER_DIGEST, + 'Content-Type', + 'User-Agent' + ], + signature_max_validity=datetime.timedelta(minutes=5) + ) + + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'tags': [ + "tags_example" + ], + } + try: + # Finds Pets by tags + api_response = api_instance.find_pets_by_tags( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->find_pets_by_tags: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/delete.md b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/delete.md new file mode 100644 index 00000000000..31a4a506cd3 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/delete.md @@ -0,0 +1,193 @@ +petstore_api.paths.pet_pet_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| delete_pet | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| delete | ApiForDelete | This api is only for this endpoint | +| delete | PetPetId | This api is only for path=/pet/{petId} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Deletes a pet | +| Path | "/pet/{petId}" | +| HTTP Method | delete | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[header_params](#header_params) | [RequestHeaderParameters.Params](#requestheaderparametersparams), dict | | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### header_params +#### RequestHeaderParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +api_key | [Parameter0.schema](#parameter0-schema), str | | optional + + +#### Parameter0 + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +petId | [Parameter1.schema](#parameter1-schema), decimal.Decimal, int | | + + +#### Parameter1 + +##### Description +Pet id to delete + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid pet value + +## ResponseFor400 + +### Description +Invalid pet value + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'petId': 1, + } + header_params = { + } + try: + # Deletes a pet + api_response = api_instance.delete_pet( + path_params=path_params, + header_params=header_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->delete_pet: %s\n" % e) + + # example passing only optional values + path_params = { + 'petId': 1, + } + header_params = { + 'api_key': "api_key_example", + } + try: + # Deletes a pet + api_response = api_instance.delete_pet( + path_params=path_params, + header_params=header_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->delete_pet: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/get.md b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/get.md new file mode 100644 index 00000000000..08cd88a646d --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/get.md @@ -0,0 +1,192 @@ +petstore_api.paths.pet_pet_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| get_pet_by_id | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| get | ApiForGet | This api is only for this endpoint | +| get | PetPetId | This api is only for path=/pet/{petId} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Find pet by ID | +| Description | Returns a single pet | +| Path | "/pet/{petId}" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | + + +#### Parameter0 + +##### Description +ID of pet to return + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Pet not found + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationXml Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Pet](../../components/schema/pet.md) | dict, frozendict.frozendict | frozendict.frozendict | +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[RefPet](../../components/schema/ref_pet.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## ResponseFor400 + +### Description +Invalid ID supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +Pet not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'petId': 1, + } + try: + # Find pet by ID + api_response = api_instance.get_pet_by_id( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->get_pet_by_id: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/post.md b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/post.md new file mode 100644 index 00000000000..ff345f026cb --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id/post.md @@ -0,0 +1,195 @@ +petstore_api.paths.pet_pet_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| update_pet_with_form | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| post | ApiForPost | This api is only for this endpoint | +| post | PetPetId | This api is only for path=/pet/{petId} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Updates a pet in the store with form data | +| Path | "/pet/{petId}" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_x_www_form_urlencoded.schema](#RequestBody-content-applicationxwwwformurlencoded-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +content_type | str | optional, default is 'application/x-www-form-urlencoded' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/x-www-form-urlencoded" | [content.application_x_www_form_urlencoded.Schema](#requestbody-content-applicationxwwwformurlencoded-schema) + +#### RequestBody content ApplicationXWwwFormUrlencoded Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**name** | str | str | Updated name of the pet | [optional] +**status** | str | str | Updated status of the pet | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | + + +#### Parameter0 + +##### Description +ID of pet that needs to be updated + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +405 | [ResponseFor405.response_cls](#responsefor405-response_cls) | Invalid input + +## ResponseFor405 + +### Description +Invalid input + +### ResponseFor405 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| +| 1 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key +# security_index 1 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + + +# security_scheme_info for security_index 1 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'petId': 1, + } + try: + # Updates a pet in the store with form data + api_response = api_instance.update_pet_with_form( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->update_pet_with_form: %s\n" % e) + + # example passing only optional values + path_params = { + 'petId': 1, + } + body = dict( + name="name_example", + status="status_example", + ) + try: + # Updates a pet in the store with form data + api_response = api_instance.update_pet_with_form( + path_params=path_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->update_pet_with_form: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id_upload_image/post.md b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id_upload_image/post.md new file mode 100644 index 00000000000..af2af3bd0cf --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/pet_pet_id_upload_image/post.md @@ -0,0 +1,173 @@ +petstore_api.paths.pet_pet_id_upload_image.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| upload_image | [PetApi](../../apis/tags/pet_api.md) | This api is only for tag=pet | +| post | ApiForPost | This api is only for this endpoint | +| post | PetPetIdUploadImage | This api is only for path=/pet/{petId}/uploadImage | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | uploads an image | +| Path | "/pet/{petId}/uploadImage" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.multipart_form_data.schema](#RequestBody-content-multipartformdata-schema), Unset, dict, frozendict.frozendict] | optional, default is unset | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +content_type | str | optional, default is 'multipart/form-data' | Selects the schema and serialization of the request body +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"multipart/form-data" | [content.multipart_form_data.Schema](#requestbody-content-multipartformdata-schema) + +#### RequestBody content MultipartFormData Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +dict, frozendict.frozendict | frozendict.frozendict | | + +##### Dictionary Keys +Key | Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- | ------------- +**additionalMetadata** | str | str | Additional data to pass to server | [optional] +**file** | bytes, io.FileIO, io.BufferedReader | bytes, io.FileIO | file to upload | [optional] +**any_string_name** | dict, frozendict.frozendict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.Schema | frozendict.frozendict, tuple, decimal.Decimal, str, bytes, BoolClass, NoneClass, FileIO | any string name can be used but the value must be the correct type | [optional] + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +petId | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | + + +#### Parameter0 + +##### Description +ID of pet to update + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessWithJsonApiResponse.response_cls](../../components/responses/response_success_with_json_api_response.md#response_success_with_json_api_responseresponse_cls) | successful operation + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["petstore_auth"](../../components/security_schemes/security_scheme_petstore_auth.md) [write:pets, read:pets]
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import pet_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_petstore_auth + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "petstore_auth": security_scheme_petstore_auth.PetstoreAuth( + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = pet_api.PetApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'petId': 1, + } + try: + # uploads an image + api_response = api_instance.upload_image( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->upload_image: %s\n" % e) + + # example passing only optional values + path_params = { + 'petId': 1, + } + body = dict( + additional_metadata="additional_metadata_example", + file=open('/path/to/file', 'rb'), + ) + try: + # uploads an image + api_response = api_instance.upload_image( + path_params=path_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling PetApi->upload_image: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to PetApi API]](../../apis/tags/pet_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/store_inventory/get.md b/samples/openapi3/client/petstore/python/docs/paths/store_inventory/get.md new file mode 100644 index 00000000000..599f15fc1b6 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/store_inventory/get.md @@ -0,0 +1,107 @@ +petstore_api.paths.store_inventory.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| get_inventory | [StoreApi](../../apis/tags/store_api.md) | This api is only for tag=store | +| get | ApiForGet | This api is only for this endpoint | +| get | StoreInventory | This api is only for path=/store/inventory | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Security](#security) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Returns pet inventories by status | +| Description | Returns a map of status codes to quantities | +| Path | "/store/inventory" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +accept_content_types | typing.Tuple[str] | default is ("application/json", ) | Tells the server the content type(s) that are accepted by the client +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessInlineContentAndHeader.response_cls](../../components/responses/response_success_inline_content_and_header.md#response_success_inline_content_and_headerresponse_cls) | successful operation + +## Security + +Set auth info by setting ApiConfiguration.security_scheme_info to a dict where the +key is the below security scheme quoted name, and the value is an instance of the linked +component security scheme class. +Select the security index by setting ApiConfiguration.security_index_info or by +passing in security_index into the endpoint method. +See how to do this in the code sample. +- these securities are specific to this to this endpoint + +| Security Index | Security Scheme to Scope Names | +| -------------- | ------------------------------ | +| 0 | ["api_key"](../../components/security_schemes/security_scheme_api_key.md) []
| + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import store_api +from pprint import pprint +# security_index 0 +from petstore_api.components.security_schemes import security_scheme_api_key + +# security_scheme_info for security_index 0 +security_scheme_info: api_configuration.SecuritySchemeInfo = { + "api_key": security_scheme_api_key.ApiKey( + api_key='sampleApiKeyValue' + ), +} + +used_configuration = api_configuration.ApiConfiguration( + security_scheme_info=security_scheme_info +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = store_api.StoreApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Returns pet inventories by status + api_response = api_instance.get_inventory() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling StoreApi->get_inventory: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to StoreApi API]](../../apis/tags/store_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/store_order/post.md b/samples/openapi3/client/petstore/python/docs/paths/store_order/post.md new file mode 100644 index 00000000000..ac8e03e8799 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/store_order/post.md @@ -0,0 +1,154 @@ +petstore_api.paths.store_order.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| place_order | [StoreApi](../../apis/tags/store_api.md) | This api is only for tag=store | +| post | ApiForPost | This api is only for this endpoint | +| post | StoreOrder | This api is only for path=/store/order | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Place an order for a pet | +| Path | "/store/order" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +order placed for purchasing the pet + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Order](../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid Order + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationXml Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Order](../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Order](../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## ResponseFor400 + +### Description +Invalid Order + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import store_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = store_api.StoreApi(api_client) + + # example passing only required values which don't have defaults set + body = order.Order( + id=1, + pet_id=1, + quantity=1, + ship_date="2020-02-02T20:20:20.000222Z", + status="placed", + complete=False, + ) + try: + # Place an order for a pet + api_response = api_instance.place_order( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling StoreApi->place_order: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to StoreApi API]](../../apis/tags/store_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/delete.md b/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/delete.md new file mode 100644 index 00000000000..65d92b8b0b5 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/delete.md @@ -0,0 +1,132 @@ +petstore_api.paths.store_order_order_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| delete_order | [StoreApi](../../apis/tags/store_api.md) | This api is only for tag=store | +| delete | ApiForDelete | This api is only for this endpoint | +| delete | StoreOrderOrderId | This api is only for path=/store/order/{order_id} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Delete purchase order by ID | +| Description | For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors | +| Path | "/store/order/{order_id}" | +| HTTP Method | delete | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +order_id | [Parameter0.schema](#parameter0-schema), str | | + + +#### Parameter0 + +##### Description +ID of the order that needs to be deleted + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Order not found + +## ResponseFor400 + +### Description +Invalid ID supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +Order not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import store_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = store_api.StoreApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'order_id': "order_id_example", + } + try: + # Delete purchase order by ID + api_response = api_instance.delete_order( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling StoreApi->delete_order: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to StoreApi API]](../../apis/tags/store_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/get.md b/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/get.md new file mode 100644 index 00000000000..2778fffbe50 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/store_order_order_id/get.md @@ -0,0 +1,166 @@ +petstore_api.paths.store_order_order_id.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| get_order_by_id | [StoreApi](../../apis/tags/store_api.md) | This api is only for tag=store | +| get | ApiForGet | This api is only for this endpoint | +| get | StoreOrderOrderId | This api is only for path=/store/order/{order_id} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Find purchase order by ID | +| Description | For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions | +| Path | "/store/order/{order_id}" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +order_id | [Parameter0.schema](#parameter0-schema), decimal.Decimal, int | | + + +#### Parameter0 + +##### Description +ID of pet that needs to be fetched + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 64 bit integer + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid ID supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | Order not found + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationXml Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Order](../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[Order](../../components/schema/order.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## ResponseFor400 + +### Description +Invalid ID supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +Order not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import store_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = store_api.StoreApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'order_id': 1, + } + try: + # Find purchase order by ID + api_response = api_instance.get_order_by_id( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling StoreApi->get_order_by_id: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to StoreApi API]](../../apis/tags/store_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user/post.md b/samples/openapi3/client/petstore/python/docs/paths/user/post.md new file mode 100644 index 00000000000..9d30c7dd171 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user/post.md @@ -0,0 +1,128 @@ +petstore_api.paths.user.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| create_user | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| post | ApiForPost | This api is only for this endpoint | +| post | User | This api is only for path=/user | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Create user | +| Description | This can only be done by the logged in user. | +| Path | "/user" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Created user object + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[User](../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [Default.response_cls](#default-response_cls) | successful operation + +## Default + +### Description +successful operation + +### Default response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + body = user.User( + id=1, + username="username_example", + first_name="first_name_example", + last_name="last_name_example", + email="email_example", + password="password_example", + phone="phone_example", + user_status=1, + object_with_no_declared_props=dict(), + object_with_no_declared_props_nullable=dict(), + any_type_prop=None, + any_type_except_null_prop=None, + any_type_prop_nullable=None, + ) + try: + # Create user + api_response = api_instance.create_user( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->create_user: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_create_with_array/post.md b/samples/openapi3/client/petstore/python/docs/paths/user_create_with_array/post.md new file mode 100644 index 00000000000..eb5a9d3c765 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_create_with_array/post.md @@ -0,0 +1,112 @@ +petstore_api.paths.user_create_with_array.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| create_users_with_array_input | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| post | ApiForPost | This api is only for this endpoint | +| post | UserCreateWithArray | This api is only for path=/user/createWithArray | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Creates list of users with given input array | +| Path | "/user/createWithArray" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_user_array.md) | typing.Union[[UserArray.content.application_json.schema](../../components/request_bodies/request_body_user_array.md#content-applicationjson-schema), list, tuple] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [Default.response_cls](#default-response_cls) | successful operation + +## Default + +### Description +successful operation + +### Default response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + body = [ + user.User( + id=1, + username="username_example", + first_name="first_name_example", + last_name="last_name_example", + email="email_example", + password="password_example", + phone="phone_example", + user_status=1, + object_with_no_declared_props=dict(), + object_with_no_declared_props_nullable=dict(), + any_type_prop=None, + any_type_except_null_prop=None, + any_type_prop_nullable=None, + ) + ] + try: + # Creates list of users with given input array + api_response = api_instance.create_users_with_array_input( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_create_with_list/post.md b/samples/openapi3/client/petstore/python/docs/paths/user_create_with_list/post.md new file mode 100644 index 00000000000..cf648150847 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_create_with_list/post.md @@ -0,0 +1,112 @@ +petstore_api.paths.user_create_with_list.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| create_users_with_list_input | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| post | ApiForPost | This api is only for this endpoint | +| post | UserCreateWithList | This api is only for path=/user/createWithList | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Creates list of users with given input array | +| Path | "/user/createWithList" | +| HTTP Method | post | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[**body**](../../components/request_bodies/request_body_ref_user_array.md) | typing.Union[[RefUserArray.content.application_json.schema](../../components/request_bodies/request_body_ref_user_array.md#content-applicationjson-schema), list, tuple] | required | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [Default.response_cls](#default-response_cls) | successful operation + +## Default + +### Description +successful operation + +### Default response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + body = [ + user.User( + id=1, + username="username_example", + first_name="first_name_example", + last_name="last_name_example", + email="email_example", + password="password_example", + phone="phone_example", + user_status=1, + object_with_no_declared_props=dict(), + object_with_no_declared_props_nullable=dict(), + any_type_prop=None, + any_type_except_null_prop=None, + any_type_prop_nullable=None, + ) + ] + try: + # Creates list of users with given input array + api_response = api_instance.create_users_with_list_input( + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_login/get.md b/samples/openapi3/client/petstore/python/docs/paths/user_login/get.md new file mode 100644 index 00000000000..e525d21c750 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_login/get.md @@ -0,0 +1,206 @@ +petstore_api.paths.user_login.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| login_user | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| get | ApiForGet | This api is only for this endpoint | +| get | UserLogin | This api is only for path=/user/login | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Logs user into the system | +| Path | "/user/login" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[query_params](#query_params) | [RequestQueryParameters.Params](#requestqueryparametersparams), dict | | +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### query_params +#### RequestQueryParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +username | [Parameter0.schema](#parameter0-schema), str | | +password | [Parameter1.schema](#parameter1-schema), str | | + + +#### Parameter0 + +##### Description +The user name for login + +##### Parameter0 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +#### Parameter1 + +##### Description +The password for login in clear text + +##### Parameter1 Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid username/password supplied + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | +[headers](#headers) | [Headers](#headers) | | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Headers +Key | Accessed Type | Description | Notes +------------- | ------------- | ------------- | ------------- +ref-schema-header | [RefSchemaHeader.schema](../../../components/headers/header_ref_schema_header.md#schema) | | +X-Rate-Limit | [headers.header_x_rate_limit.content.application_json.schema](#responsefor200-headers-xratelimit-content-applicationjson-schema) | | +int32 | [Int32JsonContentTypeHeader.content.application_json.schema](../../../components/headers/header_int32_json_content_type_header.md#content-applicationjson-schema) | | +X-Expires-After | [headers.header_x_expires_after.schema](#responsefor200-headers-xexpiresafter-schema) | | optional +ref-content-schema-header | [RefContentSchemaHeader.content.application_json.schema](../../../components/headers/header_ref_content_schema_header.md#content-applicationjson-schema) | | +stringHeader | [RefStringHeader.schema](../../../components/headers/header_ref_string_header.md#schema) | | +numberHeader | [NumberHeader.schema](../../../components/headers/header_number_header.md#schema) | | optional + +### Body Details +#### ResponseFor200 content ApplicationXml Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str | str | | + +### Header Details +#### ResponseFor200 headers XRateLimit + +##### Description +calls per hour allowed by the user + +##### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#responsefor200-headers-xratelimit-content-applicationjson-schema) + +##### ResponseFor200 headers XRateLimit content ApplicationJson Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +decimal.Decimal, int | decimal.Decimal | | value must be a 32 bit integer +#### ResponseFor200 headers XExpiresAfter + +##### Description +date in UTC when token expires + +##### ResponseFor200 headers XExpiresAfter Schema + +###### Type Info +Input Type | Accessed Type | Description | Notes +------------ | ------------- | ------------- | ------------- +str, datetime.datetime | str | | value must conform to RFC-3339 date-time + +## ResponseFor400 + +### Description +Invalid username/password supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + query_params = { + 'username': "username_example", + 'password': "password_example", + } + try: + # Logs user into the system + api_response = api_instance.login_user( + query_params=query_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->login_user: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_logout/get.md b/samples/openapi3/client/petstore/python/docs/paths/user_logout/get.md new file mode 100644 index 00000000000..07357ef5c53 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_logout/get.md @@ -0,0 +1,79 @@ +petstore_api.paths.user_logout.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| logout_user | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| get | ApiForGet | This api is only for this endpoint | +| get | UserLogout | This api is only for path=/user/logout | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Logs out current logged in user session | +| Path | "/user/logout" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +default | [RefSuccessDescriptionOnly.response_cls](../../components/responses/response_ref_success_description_only.md#response_ref_success_description_onlyresponse_cls) | Success + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Logs out current logged in user session + api_response = api_instance.logout_user() + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->logout_user: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_username/delete.md b/samples/openapi3/client/petstore/python/docs/paths/user_username/delete.md new file mode 100644 index 00000000000..5f10a694961 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_username/delete.md @@ -0,0 +1,108 @@ +petstore_api.paths.user_username.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| delete_user | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| delete | ApiForDelete | This api is only for this endpoint | +| delete | UserUsername | This api is only for path=/user/{username} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Delete user | +| Description | This can only be done by the logged in user. | +| Path | "/user/{username}" | +| HTTP Method | delete | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +username | [RefPathUserName.schema](../../../components/parameters/parameter_ref_path_user_name.md#schema), str | | + + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [SuccessDescriptionOnly.response_cls](../../components/responses/response_success_description_only.md#response_success_description_onlyresponse_cls) | Success +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found + +## ResponseFor404 + +### Description +User not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'username': "username_example", + } + try: + # Delete user + api_response = api_instance.delete_user( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->delete_user: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_username/get.md b/samples/openapi3/client/petstore/python/docs/paths/user_username/get.md new file mode 100644 index 00000000000..b7311b646b1 --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_username/get.md @@ -0,0 +1,153 @@ +petstore_api.paths.user_username.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| get_user_by_name | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| get | ApiForGet | This api is only for this endpoint | +| get | UserUsername | This api is only for path=/user/{username} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Get user by user name | +| Path | "/user/{username}" | +| HTTP Method | get | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +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 +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +username | [PathUserName.schema](../../../components/parameters/parameter_path_user_name.md#schema), str | | + + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +200 | [ResponseFor200.response_cls](#responsefor200-response_cls) | successful operation +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid username supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found + +## ResponseFor200 + +### Description +successful operation + +### ResponseFor200 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +[body](#responsefor200-body) | typing.Union[[content.application_xml.schema](#responsefor200-content-applicationxml-schema), [content.application_json.schema](#responsefor200-content-applicationjson-schema)] | | +headers | Unset | headers were not defined | + +### ResponseFor200 Body +Content-Type | Schema +------------ | ------- +"application/xml" | [content.application_xml.Schema](#responsefor200-content-applicationxml-schema) +"application/json" | [content.application_json.Schema](#responsefor200-content-applicationjson-schema) + +### Body Details +#### ResponseFor200 content ApplicationXml Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[User](../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | +#### ResponseFor200 content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[User](../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | + +## ResponseFor400 + +### Description +Invalid username supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +User not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'username': "username_example", + } + try: + # Get user by user name + api_response = api_instance.get_user_by_name( + path_params=path_params, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->get_user_by_name: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file diff --git a/samples/openapi3/client/petstore/python/docs/paths/user_username/put.md b/samples/openapi3/client/petstore/python/docs/paths/user_username/put.md new file mode 100644 index 00000000000..74d3e281e5f --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/paths/user_username/put.md @@ -0,0 +1,155 @@ +petstore_api.paths.user_username.operation +# Operation Method Name + +| Method Name | Api Class | Notes | +| ----------- | --------- | ----- | +| update_user | [UserApi](../../apis/tags/user_api.md) | This api is only for tag=user | +| put | ApiForPut | This api is only for this endpoint | +| put | UserUsername | This api is only for path=/user/{username} | + +## Table of Contents +- [General Info](#general-info) +- [Arguments](#arguments) +- [Return Types](#return-types) +- [Servers](#servers) +- [Code Sample](#code-sample) + +## General Info +| Field | Value | +| ----- | ----- | +| Summary | Updated user | +| Description | This can only be done by the logged in user. | +| Path | "/user/{username}" | +| HTTP Method | put | + +## Arguments + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +[body](#requestbody) | typing.Union[[RequestBody.content.application_json.schema](#RequestBody-content-applicationjson-schema), dict, frozendict.frozendict] | required | +[path_params](#path_params) | [RequestPathParameters.Params](#requestpathparametersparams), dict | | +content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body +server_index | typing.Optional[int] | default is None | Allows one to select a different server +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 +timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client +skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned + +### RequestBody + +#### Description +Updated user object + +#### Content Type To Schema +Content-Type | Schema +------------ | ------- +"application/json" | [content.application_json.Schema](#requestbody-content-applicationjson-schema) + +#### RequestBody content ApplicationJson Schema + +##### Type Info +Ref Class | Input Type | Accessed Type | Description +--------- | ---------- | ------------- | ------------ +[User](../../components/schema/user.md) | dict, frozendict.frozendict | frozendict.frozendict | + +### path_params +#### RequestPathParameters.Params +This is a TypedDict + +Key | Input Type | Description | Notes +------------- | ------------- | ------------- | ------------- +username | [PathUserName.schema](../../../components/parameters/parameter_path_user_name.md#schema), str | | + + +## Return Types + +HTTP Status Code | Class | Description +------------- | ------------- | ------------- +n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned +400 | [ResponseFor400.response_cls](#responsefor400-response_cls) | Invalid user supplied +404 | [ResponseFor404.response_cls](#responsefor404-response_cls) | User not found + +## ResponseFor400 + +### Description +Invalid user supplied + +### ResponseFor400 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## ResponseFor404 + +### Description +User not found + +### ResponseFor404 response_cls +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +response | urllib3.HTTPResponse | Raw response | +body | Unset | body was not defined | +headers | Unset | headers were not defined | + +## Servers + +Set the available servers by defining your used servers in ApiConfiguration.server_info +Then select your server by setting a server index in ApiConfiguration.server_index_info or by +passing server_index in to the endpoint method. +- these servers are the general api servers +- defaults to server_index=0, server.url = http://petstore.swagger.io:80/v2 + +server_index | Class | Description +------------ | ----- | ------------ +0 | [Server0](../../../servers/server_0.md) | petstore server +1 | [Server1](../../../servers/server_1.md) | The local server +2 | [Server2](../../../servers/server_2.md) | staging server with no variables + +## Code Sample + +```python +import petstore_api +from petstore_api.configurations import api_configuration +from petstore_api.apis.tags import user_api +from pprint import pprint +used_configuration = api_configuration.ApiConfiguration( +) +# Enter a context with an instance of the API client +with petstore_api.ApiClient(used_configuration) as api_client: + # Create an instance of the API class + api_instance = user_api.UserApi(api_client) + + # example passing only required values which don't have defaults set + path_params = { + 'username': "username_example", + } + body = user.User( + id=1, + username="username_example", + first_name="first_name_example", + last_name="last_name_example", + email="email_example", + password="password_example", + phone="phone_example", + user_status=1, + object_with_no_declared_props=dict(), + object_with_no_declared_props_nullable=dict(), + any_type_prop=None, + any_type_except_null_prop=None, + any_type_prop_nullable=None, + ) + try: + # Updated user + api_response = api_instance.update_user( + path_params=path_params, + body=body, + ) + pprint(api_response) + except petstore_api.ApiException as e: + print("Exception when calling UserApi->update_user: %s\n" % e) +``` + +[[Back to top]](#top) +[[Back to UserApi API]](../../apis/tags/user_api.md) +[[Back to Endpoints]](../../../README.md#Endpoints) [[Back to README]](../../../README.md) \ No newline at end of file