diff --git a/samples/client/3_0_3_unit_test/python/src/unit_test_api/apis/tag_to_api.py b/samples/client/3_0_3_unit_test/python/src/unit_test_api/apis/tag_to_api.py index 615b9da6db3..62866c1972f 100644 --- a/samples/client/3_0_3_unit_test/python/src/unit_test_api/apis/tag_to_api.py +++ b/samples/client/3_0_3_unit_test/python/src/unit_test_api/apis/tag_to_api.py @@ -1,98 +1,98 @@ import typing import typing_extensions -from unit_test_api.apis.tags.maximum_api import MaximumApi -from unit_test_api.apis.tags.pattern_api import PatternApi -from unit_test_api.apis.tags.additional_properties_api import AdditionalPropertiesApi -from unit_test_api.apis.tags.response_content_content_type_schema_api import ResponseContentContentTypeSchemaApi -from unit_test_api.apis.tags.min_items_api import MinItemsApi -from unit_test_api.apis.tags.min_length_api import MinLengthApi -from unit_test_api.apis.tags.required_api import RequiredApi -from unit_test_api.apis.tags.max_length_api import MaxLengthApi -from unit_test_api.apis.tags._not_api import _NotApi -from unit_test_api.apis.tags.path_post_api import PathPostApi -from unit_test_api.apis.tags.min_properties_api import MinPropertiesApi -from unit_test_api.apis.tags.unique_items_api import UniqueItemsApi from unit_test_api.apis.tags.operation_request_body_api import OperationRequestBodyApi -from unit_test_api.apis.tags.one_of_api import OneOfApi -from unit_test_api.apis.tags.ref_api import RefApi +from unit_test_api.apis.tags.path_post_api import PathPostApi +from unit_test_api.apis.tags.content_type_json_api import ContentTypeJsonApi +from unit_test_api.apis.tags.additional_properties_api import AdditionalPropertiesApi from unit_test_api.apis.tags.all_of_api import AllOfApi -from unit_test_api.apis.tags.minimum_api import MinimumApi from unit_test_api.apis.tags.any_of_api import AnyOfApi -from unit_test_api.apis.tags.multiple_of_api import MultipleOfApi from unit_test_api.apis.tags.type_api import TypeApi -from unit_test_api.apis.tags.items_api import ItemsApi +from unit_test_api.apis.tags.multiple_of_api import MultipleOfApi from unit_test_api.apis.tags.format_api import FormatApi -from unit_test_api.apis.tags.properties_api import PropertiesApi -from unit_test_api.apis.tags.default_api import DefaultApi -from unit_test_api.apis.tags.content_type_json_api import ContentTypeJsonApi -from unit_test_api.apis.tags.max_properties_api import MaxPropertiesApi from unit_test_api.apis.tags.enum_api import EnumApi +from unit_test_api.apis.tags._not_api import _NotApi +from unit_test_api.apis.tags.default_api import DefaultApi +from unit_test_api.apis.tags.maximum_api import MaximumApi from unit_test_api.apis.tags.max_items_api import MaxItemsApi +from unit_test_api.apis.tags.max_length_api import MaxLengthApi +from unit_test_api.apis.tags.max_properties_api import MaxPropertiesApi +from unit_test_api.apis.tags.minimum_api import MinimumApi +from unit_test_api.apis.tags.min_items_api import MinItemsApi +from unit_test_api.apis.tags.min_length_api import MinLengthApi +from unit_test_api.apis.tags.min_properties_api import MinPropertiesApi +from unit_test_api.apis.tags.items_api import ItemsApi +from unit_test_api.apis.tags.one_of_api import OneOfApi +from unit_test_api.apis.tags.properties_api import PropertiesApi +from unit_test_api.apis.tags.pattern_api import PatternApi +from unit_test_api.apis.tags.ref_api import RefApi +from unit_test_api.apis.tags.required_api import RequiredApi +from unit_test_api.apis.tags.unique_items_api import UniqueItemsApi +from unit_test_api.apis.tags.response_content_content_type_schema_api import ResponseContentContentTypeSchemaApi TagToApi = typing.TypedDict( 'TagToApi', { - "maximum": typing.Type[MaximumApi], - "pattern": typing.Type[PatternApi], - "additionalProperties": typing.Type[AdditionalPropertiesApi], - "response.content.contentType.schema": typing.Type[ResponseContentContentTypeSchemaApi], - "minItems": typing.Type[MinItemsApi], - "minLength": typing.Type[MinLengthApi], - "required": typing.Type[RequiredApi], - "maxLength": typing.Type[MaxLengthApi], - "not": typing.Type[_NotApi], - "path.post": typing.Type[PathPostApi], - "minProperties": typing.Type[MinPropertiesApi], - "uniqueItems": typing.Type[UniqueItemsApi], "operation.requestBody": typing.Type[OperationRequestBodyApi], - "oneOf": typing.Type[OneOfApi], - "$ref": typing.Type[RefApi], + "path.post": typing.Type[PathPostApi], + "contentType_json": typing.Type[ContentTypeJsonApi], + "additionalProperties": typing.Type[AdditionalPropertiesApi], "allOf": typing.Type[AllOfApi], - "minimum": typing.Type[MinimumApi], "anyOf": typing.Type[AnyOfApi], - "multipleOf": typing.Type[MultipleOfApi], "type": typing.Type[TypeApi], - "items": typing.Type[ItemsApi], + "multipleOf": typing.Type[MultipleOfApi], "format": typing.Type[FormatApi], - "properties": typing.Type[PropertiesApi], - "default": typing.Type[DefaultApi], - "contentType_json": typing.Type[ContentTypeJsonApi], - "maxProperties": typing.Type[MaxPropertiesApi], "enum": typing.Type[EnumApi], + "not": typing.Type[_NotApi], + "default": typing.Type[DefaultApi], + "maximum": typing.Type[MaximumApi], "maxItems": typing.Type[MaxItemsApi], + "maxLength": typing.Type[MaxLengthApi], + "maxProperties": typing.Type[MaxPropertiesApi], + "minimum": typing.Type[MinimumApi], + "minItems": typing.Type[MinItemsApi], + "minLength": typing.Type[MinLengthApi], + "minProperties": typing.Type[MinPropertiesApi], + "items": typing.Type[ItemsApi], + "oneOf": typing.Type[OneOfApi], + "properties": typing.Type[PropertiesApi], + "pattern": typing.Type[PatternApi], + "$ref": typing.Type[RefApi], + "required": typing.Type[RequiredApi], + "uniqueItems": typing.Type[UniqueItemsApi], + "response.content.contentType.schema": typing.Type[ResponseContentContentTypeSchemaApi], } ) tag_to_api = TagToApi( { - "maximum": MaximumApi, - "pattern": PatternApi, - "additionalProperties": AdditionalPropertiesApi, - "response.content.contentType.schema": ResponseContentContentTypeSchemaApi, - "minItems": MinItemsApi, - "minLength": MinLengthApi, - "required": RequiredApi, - "maxLength": MaxLengthApi, - "not": _NotApi, - "path.post": PathPostApi, - "minProperties": MinPropertiesApi, - "uniqueItems": UniqueItemsApi, "operation.requestBody": OperationRequestBodyApi, - "oneOf": OneOfApi, - "$ref": RefApi, + "path.post": PathPostApi, + "contentType_json": ContentTypeJsonApi, + "additionalProperties": AdditionalPropertiesApi, "allOf": AllOfApi, - "minimum": MinimumApi, "anyOf": AnyOfApi, - "multipleOf": MultipleOfApi, "type": TypeApi, - "items": ItemsApi, + "multipleOf": MultipleOfApi, "format": FormatApi, - "properties": PropertiesApi, - "default": DefaultApi, - "contentType_json": ContentTypeJsonApi, - "maxProperties": MaxPropertiesApi, "enum": EnumApi, + "not": _NotApi, + "default": DefaultApi, + "maximum": MaximumApi, "maxItems": MaxItemsApi, + "maxLength": MaxLengthApi, + "maxProperties": MaxPropertiesApi, + "minimum": MinimumApi, + "minItems": MinItemsApi, + "minLength": MinLengthApi, + "minProperties": MinPropertiesApi, + "items": ItemsApi, + "oneOf": OneOfApi, + "properties": PropertiesApi, + "pattern": PatternApi, + "$ref": RefApi, + "required": RequiredApi, + "uniqueItems": UniqueItemsApi, + "response.content.contentType.schema": ResponseContentContentTypeSchemaApi, } ) diff --git a/samples/client/3_1_0_unit_test/python/src/unit_test_api/apis/tag_to_api.py b/samples/client/3_1_0_unit_test/python/src/unit_test_api/apis/tag_to_api.py index a20ee6fc0e8..34a66428b01 100644 --- a/samples/client/3_1_0_unit_test/python/src/unit_test_api/apis/tag_to_api.py +++ b/samples/client/3_1_0_unit_test/python/src/unit_test_api/apis/tag_to_api.py @@ -1,137 +1,137 @@ import typing import typing_extensions +from unit_test_api.apis.tags.operation_request_body_api import OperationRequestBodyApi +from unit_test_api.apis.tags.path_post_api import PathPostApi from unit_test_api.apis.tags.prefix_items_api import PrefixItemsApi -from unit_test_api.apis.tags.maximum_api import MaximumApi -from unit_test_api.apis.tags.pattern_api import PatternApi +from unit_test_api.apis.tags.content_type_json_api import ContentTypeJsonApi from unit_test_api.apis.tags.additional_properties_api import AdditionalPropertiesApi -from unit_test_api.apis.tags.response_content_content_type_schema_api import ResponseContentContentTypeSchemaApi -from unit_test_api.apis.tags.dependent_required_api import DependentRequiredApi -from unit_test_api.apis.tags.min_items_api import MinItemsApi -from unit_test_api.apis.tags.min_length_api import MinLengthApi -from unit_test_api.apis.tags.required_api import RequiredApi -from unit_test_api.apis.tags.max_length_api import MaxLengthApi -from unit_test_api.apis.tags._not_api import _NotApi -from unit_test_api.apis.tags.unevaluated_items_api import UnevaluatedItemsApi -from unit_test_api.apis.tags.path_post_api import PathPostApi -from unit_test_api.apis.tags.exclusive_minimum_api import ExclusiveMinimumApi -from unit_test_api.apis.tags.if_then_else_api import IfThenElseApi -from unit_test_api.apis.tags.min_properties_api import MinPropertiesApi -from unit_test_api.apis.tags.property_names_api import PropertyNamesApi -from unit_test_api.apis.tags.unique_items_api import UniqueItemsApi -from unit_test_api.apis.tags.operation_request_body_api import OperationRequestBodyApi -from unit_test_api.apis.tags.contains_api import ContainsApi -from unit_test_api.apis.tags.one_of_api import OneOfApi -from unit_test_api.apis.tags.min_contains_api import MinContainsApi -from unit_test_api.apis.tags.max_contains_api import MaxContainsApi -from unit_test_api.apis.tags.ref_api import RefApi from unit_test_api.apis.tags.all_of_api import AllOfApi -from unit_test_api.apis.tags.exclusive_maximum_api import ExclusiveMaximumApi -from unit_test_api.apis.tags.minimum_api import MinimumApi from unit_test_api.apis.tags.any_of_api import AnyOfApi -from unit_test_api.apis.tags.multiple_of_api import MultipleOfApi from unit_test_api.apis.tags.type_api import TypeApi -from unit_test_api.apis.tags.items_api import ItemsApi -from unit_test_api.apis.tags.format_api import FormatApi -from unit_test_api.apis.tags.properties_api import PropertiesApi -from unit_test_api.apis.tags.content_type_json_api import ContentTypeJsonApi -from unit_test_api.apis.tags.max_properties_api import MaxPropertiesApi -from unit_test_api.apis.tags.unevaluated_properties_api import UnevaluatedPropertiesApi +from unit_test_api.apis.tags.multiple_of_api import MultipleOfApi from unit_test_api.apis.tags.const_api import ConstApi +from unit_test_api.apis.tags.contains_api import ContainsApi +from unit_test_api.apis.tags.format_api import FormatApi +from unit_test_api.apis.tags.dependent_schemas_api import DependentSchemasApi +from unit_test_api.apis.tags.dependent_required_api import DependentRequiredApi from unit_test_api.apis.tags.enum_api import EnumApi +from unit_test_api.apis.tags.exclusive_maximum_api import ExclusiveMaximumApi +from unit_test_api.apis.tags.exclusive_minimum_api import ExclusiveMinimumApi +from unit_test_api.apis.tags._not_api import _NotApi +from unit_test_api.apis.tags.if_then_else_api import IfThenElseApi +from unit_test_api.apis.tags.items_api import ItemsApi +from unit_test_api.apis.tags.max_contains_api import MaxContainsApi +from unit_test_api.apis.tags.maximum_api import MaximumApi from unit_test_api.apis.tags.max_items_api import MaxItemsApi +from unit_test_api.apis.tags.max_length_api import MaxLengthApi +from unit_test_api.apis.tags.max_properties_api import MaxPropertiesApi +from unit_test_api.apis.tags.min_contains_api import MinContainsApi +from unit_test_api.apis.tags.minimum_api import MinimumApi +from unit_test_api.apis.tags.min_items_api import MinItemsApi +from unit_test_api.apis.tags.min_length_api import MinLengthApi +from unit_test_api.apis.tags.min_properties_api import MinPropertiesApi from unit_test_api.apis.tags.pattern_properties_api import PatternPropertiesApi -from unit_test_api.apis.tags.dependent_schemas_api import DependentSchemasApi +from unit_test_api.apis.tags.one_of_api import OneOfApi +from unit_test_api.apis.tags.properties_api import PropertiesApi +from unit_test_api.apis.tags.pattern_api import PatternApi +from unit_test_api.apis.tags.ref_api import RefApi +from unit_test_api.apis.tags.property_names_api import PropertyNamesApi +from unit_test_api.apis.tags.required_api import RequiredApi +from unit_test_api.apis.tags.unevaluated_items_api import UnevaluatedItemsApi +from unit_test_api.apis.tags.unevaluated_properties_api import UnevaluatedPropertiesApi +from unit_test_api.apis.tags.unique_items_api import UniqueItemsApi +from unit_test_api.apis.tags.response_content_content_type_schema_api import ResponseContentContentTypeSchemaApi TagToApi = typing.TypedDict( 'TagToApi', { + "operation.requestBody": typing.Type[OperationRequestBodyApi], + "path.post": typing.Type[PathPostApi], "prefixItems": typing.Type[PrefixItemsApi], - "maximum": typing.Type[MaximumApi], - "pattern": typing.Type[PatternApi], + "contentType_json": typing.Type[ContentTypeJsonApi], "additionalProperties": typing.Type[AdditionalPropertiesApi], - "response.content.contentType.schema": typing.Type[ResponseContentContentTypeSchemaApi], - "dependentRequired": typing.Type[DependentRequiredApi], - "minItems": typing.Type[MinItemsApi], - "minLength": typing.Type[MinLengthApi], - "required": typing.Type[RequiredApi], - "maxLength": typing.Type[MaxLengthApi], - "not": typing.Type[_NotApi], - "unevaluatedItems": typing.Type[UnevaluatedItemsApi], - "path.post": typing.Type[PathPostApi], - "exclusiveMinimum": typing.Type[ExclusiveMinimumApi], - "if-then-else": typing.Type[IfThenElseApi], - "minProperties": typing.Type[MinPropertiesApi], - "propertyNames": typing.Type[PropertyNamesApi], - "uniqueItems": typing.Type[UniqueItemsApi], - "operation.requestBody": typing.Type[OperationRequestBodyApi], - "contains": typing.Type[ContainsApi], - "oneOf": typing.Type[OneOfApi], - "minContains": typing.Type[MinContainsApi], - "maxContains": typing.Type[MaxContainsApi], - "$ref": typing.Type[RefApi], "allOf": typing.Type[AllOfApi], - "exclusiveMaximum": typing.Type[ExclusiveMaximumApi], - "minimum": typing.Type[MinimumApi], "anyOf": typing.Type[AnyOfApi], - "multipleOf": typing.Type[MultipleOfApi], "type": typing.Type[TypeApi], - "items": typing.Type[ItemsApi], - "format": typing.Type[FormatApi], - "properties": typing.Type[PropertiesApi], - "contentType_json": typing.Type[ContentTypeJsonApi], - "maxProperties": typing.Type[MaxPropertiesApi], - "unevaluatedProperties": typing.Type[UnevaluatedPropertiesApi], + "multipleOf": typing.Type[MultipleOfApi], "const": typing.Type[ConstApi], + "contains": typing.Type[ContainsApi], + "format": typing.Type[FormatApi], + "dependentSchemas": typing.Type[DependentSchemasApi], + "dependentRequired": typing.Type[DependentRequiredApi], "enum": typing.Type[EnumApi], + "exclusiveMaximum": typing.Type[ExclusiveMaximumApi], + "exclusiveMinimum": typing.Type[ExclusiveMinimumApi], + "not": typing.Type[_NotApi], + "if-then-else": typing.Type[IfThenElseApi], + "items": typing.Type[ItemsApi], + "maxContains": typing.Type[MaxContainsApi], + "maximum": typing.Type[MaximumApi], "maxItems": typing.Type[MaxItemsApi], + "maxLength": typing.Type[MaxLengthApi], + "maxProperties": typing.Type[MaxPropertiesApi], + "minContains": typing.Type[MinContainsApi], + "minimum": typing.Type[MinimumApi], + "minItems": typing.Type[MinItemsApi], + "minLength": typing.Type[MinLengthApi], + "minProperties": typing.Type[MinPropertiesApi], "patternProperties": typing.Type[PatternPropertiesApi], - "dependentSchemas": typing.Type[DependentSchemasApi], + "oneOf": typing.Type[OneOfApi], + "properties": typing.Type[PropertiesApi], + "pattern": typing.Type[PatternApi], + "$ref": typing.Type[RefApi], + "propertyNames": typing.Type[PropertyNamesApi], + "required": typing.Type[RequiredApi], + "unevaluatedItems": typing.Type[UnevaluatedItemsApi], + "unevaluatedProperties": typing.Type[UnevaluatedPropertiesApi], + "uniqueItems": typing.Type[UniqueItemsApi], + "response.content.contentType.schema": typing.Type[ResponseContentContentTypeSchemaApi], } ) tag_to_api = TagToApi( { + "operation.requestBody": OperationRequestBodyApi, + "path.post": PathPostApi, "prefixItems": PrefixItemsApi, - "maximum": MaximumApi, - "pattern": PatternApi, + "contentType_json": ContentTypeJsonApi, "additionalProperties": AdditionalPropertiesApi, - "response.content.contentType.schema": ResponseContentContentTypeSchemaApi, - "dependentRequired": DependentRequiredApi, - "minItems": MinItemsApi, - "minLength": MinLengthApi, - "required": RequiredApi, - "maxLength": MaxLengthApi, - "not": _NotApi, - "unevaluatedItems": UnevaluatedItemsApi, - "path.post": PathPostApi, - "exclusiveMinimum": ExclusiveMinimumApi, - "if-then-else": IfThenElseApi, - "minProperties": MinPropertiesApi, - "propertyNames": PropertyNamesApi, - "uniqueItems": UniqueItemsApi, - "operation.requestBody": OperationRequestBodyApi, - "contains": ContainsApi, - "oneOf": OneOfApi, - "minContains": MinContainsApi, - "maxContains": MaxContainsApi, - "$ref": RefApi, "allOf": AllOfApi, - "exclusiveMaximum": ExclusiveMaximumApi, - "minimum": MinimumApi, "anyOf": AnyOfApi, - "multipleOf": MultipleOfApi, "type": TypeApi, - "items": ItemsApi, - "format": FormatApi, - "properties": PropertiesApi, - "contentType_json": ContentTypeJsonApi, - "maxProperties": MaxPropertiesApi, - "unevaluatedProperties": UnevaluatedPropertiesApi, + "multipleOf": MultipleOfApi, "const": ConstApi, + "contains": ContainsApi, + "format": FormatApi, + "dependentSchemas": DependentSchemasApi, + "dependentRequired": DependentRequiredApi, "enum": EnumApi, + "exclusiveMaximum": ExclusiveMaximumApi, + "exclusiveMinimum": ExclusiveMinimumApi, + "not": _NotApi, + "if-then-else": IfThenElseApi, + "items": ItemsApi, + "maxContains": MaxContainsApi, + "maximum": MaximumApi, "maxItems": MaxItemsApi, + "maxLength": MaxLengthApi, + "maxProperties": MaxPropertiesApi, + "minContains": MinContainsApi, + "minimum": MinimumApi, + "minItems": MinItemsApi, + "minLength": MinLengthApi, + "minProperties": MinPropertiesApi, "patternProperties": PatternPropertiesApi, - "dependentSchemas": DependentSchemasApi, + "oneOf": OneOfApi, + "properties": PropertiesApi, + "pattern": PatternApi, + "$ref": RefApi, + "propertyNames": PropertyNamesApi, + "required": RequiredApi, + "unevaluatedItems": UnevaluatedItemsApi, + "unevaluatedProperties": UnevaluatedPropertiesApi, + "uniqueItems": UniqueItemsApi, + "response.content.contentType.schema": ResponseContentContentTypeSchemaApi, } ) diff --git a/samples/client/petstore/java/docs/components/schemas/Capitalization.md b/samples/client/petstore/java/docs/components/schemas/Capitalization.md index 8396378c92e..52c339a5c0e 100644 --- a/samples/client/petstore/java/docs/components/schemas/Capitalization.md +++ b/samples/client/petstore/java/docs/components/schemas/Capitalization.md @@ -109,8 +109,7 @@ type: Map | **small_Snake** | String | | [optional] | | **Capital_Snake** | String | | [optional] | | **SCA_ETH_Flow_Points** | String | | [optional] | -| **ATT_NAME** | String | Name of the pet - | [optional] | +| **ATT_NAME** | String | Name of the pet
| [optional] | | **anyStringName** | Object | any string name can be used but the value must be the correct type | [optional] | ## ATTNAME @@ -120,8 +119,7 @@ extends StringJsonSchema A schema class that validates payloads ## Description -Name of the pet - +Name of the pet
| Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema | | ------------------------------------------------------------------ | diff --git a/samples/client/petstore/python/README.md b/samples/client/petstore/python/README.md index d7ccae1b955..57f380ec4ab 100644 --- a/samples/client/petstore/python/README.md +++ b/samples/client/petstore/python/README.md @@ -178,11 +178,7 @@ HTTP request | Method | Description /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 **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) | @@ -398,8 +394,7 @@ Class | Description Class | Description ----- | ------------ -[HeadersWithNoBody](docs/components/responses/response_headers_with_no_body.md) | A response that contains headers but no body - +[HeadersWithNoBody](docs/components/responses/response_headers_with_no_body.md) | A response that contains headers but no body
[RefSuccessDescriptionOnly](docs/components/responses/response_ref_success_description_only.md) | [RefSuccessfulXmlAndJsonArrayOfPet](docs/components/responses/response_ref_successful_xml_and_json_array_of_pet.md) | [SuccessDescriptionOnly](docs/components/responses/response_success_description_only.md) | Success diff --git a/samples/client/petstore/python/docs/apis/tags/fake_api.md b/samples/client/petstore/python/docs/apis/tags/fake_api.md index 2c2943ea12e..8bcd805c4e4 100644 --- a/samples/client/petstore/python/docs/apis/tags/fake_api.md +++ b/samples/client/petstore/python/docs/apis/tags/fake_api.md @@ -20,11 +20,7 @@ Method | Description [**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 [**delete_common_param**](../../paths/common_param_sub_dir/delete.md) | -[**endpoint_parameters**](../../paths/fake/post.md) | Fake endpoint for testing various parameters -假端點 -偽のエンドポイント -가짜 엔드 포인트 - +[**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 [**get_common_param**](../../paths/common_param_sub_dir/get.md) | diff --git a/samples/client/petstore/python/docs/components/responses/response_headers_with_no_body.md b/samples/client/petstore/python/docs/components/responses/response_headers_with_no_body.md index d3a3860d484..87f82693b72 100644 --- a/samples/client/petstore/python/docs/components/responses/response_headers_with_no_body.md +++ b/samples/client/petstore/python/docs/components/responses/response_headers_with_no_body.md @@ -2,8 +2,7 @@ petstore_api.components.responses.response_headers_with_no_body # Response HeadersWithNoBody ## Description -A response that contains headers but no body - +A response that contains headers but no body
## ApiResponse Name | Type | Description | Notes diff --git a/samples/client/petstore/python/docs/components/schema/capitalization.md b/samples/client/petstore/python/docs/components/schema/capitalization.md index 77df7c4dc3c..e920943cb6b 100644 --- a/samples/client/petstore/python/docs/components/schema/capitalization.md +++ b/samples/client/petstore/python/docs/components/schema/capitalization.md @@ -20,8 +20,7 @@ Key | Type | Description | Notes **small_Snake** | str | | [optional] **Capital_Snake** | str | | [optional] **SCA_ETH_Flow_Points** | str | | [optional] -**ATT_NAME** | str | Name of the pet - | [optional] +**ATT_NAME** | str | Name of the pet
| [optional] **any_string_name** | dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO | any string name can be used but the value must be the correct type | [optional] ## CapitalizationDict @@ -37,8 +36,7 @@ Keyword Argument | Type | Description | Notes **small_Snake** | str, schemas.Unset | | [optional] **Capital_Snake** | str, schemas.Unset | | [optional] **SCA_ETH_Flow_Points** | str, schemas.Unset | | [optional] -**ATT_NAME** | str, schemas.Unset | Name of the pet - | [optional] +**ATT_NAME** | str, schemas.Unset | Name of the pet
| [optional] **kwargs** | schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO | any string name can be used but the value must be the correct type | [optional] typed value is accessed with the get_additional_property_ method ### properties @@ -49,8 +47,7 @@ Property | Type | Description | Notes **small_Snake** | str, schemas.Unset | | [optional] **Capital_Snake** | str, schemas.Unset | | [optional] **SCA_ETH_Flow_Points** | str, schemas.Unset | | [optional] -**ATT_NAME** | str, schemas.Unset | Name of the pet - | [optional] +**ATT_NAME** | str, schemas.Unset | Name of the pet
| [optional] ### methods Method | Input Type | Return Type | Notes diff --git a/samples/client/petstore/python/docs/paths/fake/post.md b/samples/client/petstore/python/docs/paths/fake/post.md index 8a005229f36..e88111d7b92 100644 --- a/samples/client/petstore/python/docs/paths/fake/post.md +++ b/samples/client/petstore/python/docs/paths/fake/post.md @@ -18,16 +18,8 @@ petstore_api.paths.fake.operation ## General Info | Field | Value | | ----- | ----- | -| Summary | Fake endpoint for testing various parameters -假端點 -偽のエンドポイント -가짜 엔드 포인트 - | -| Description | Fake endpoint for testing various parameters -假端點 -偽のエンドポイント -가짜 엔드 포인트 - | +| Summary | Fake endpoint for testing various parameters
假端點
偽のエンドポイント
가짜 엔드 포인트
| +| Description | Fake endpoint for testing various parameters
假端點
偽のエンドポイント
가짜 엔드 포인트
| | Path | "/fake" | | HTTP Method | post | diff --git a/samples/client/petstore/python/src/petstore_api/apis/tag_to_api.py b/samples/client/petstore/python/src/petstore_api/apis/tag_to_api.py index d224b343cae..b1dfb1b38fb 100644 --- a/samples/client/petstore/python/src/petstore_api/apis/tag_to_api.py +++ b/samples/client/petstore/python/src/petstore_api/apis/tag_to_api.py @@ -1,35 +1,35 @@ import typing import typing_extensions -from petstore_api.apis.tags.default_api import DefaultApi from petstore_api.apis.tags.fake_api import FakeApi +from petstore_api.apis.tags.another_fake_api import AnotherFakeApi from petstore_api.apis.tags.pet_api import PetApi from petstore_api.apis.tags.fake_classname_tags123_api import FakeClassnameTags123Api -from petstore_api.apis.tags.user_api import UserApi +from petstore_api.apis.tags.default_api import DefaultApi from petstore_api.apis.tags.store_api import StoreApi -from petstore_api.apis.tags.another_fake_api import AnotherFakeApi +from petstore_api.apis.tags.user_api import UserApi TagToApi = typing.TypedDict( 'TagToApi', { - "default": typing.Type[DefaultApi], "fake": typing.Type[FakeApi], + "$another-fake?": typing.Type[AnotherFakeApi], "pet": typing.Type[PetApi], "fake_classname_tags 123#$%^": typing.Type[FakeClassnameTags123Api], - "user": typing.Type[UserApi], + "default": typing.Type[DefaultApi], "store": typing.Type[StoreApi], - "$another-fake?": typing.Type[AnotherFakeApi], + "user": typing.Type[UserApi], } ) tag_to_api = TagToApi( { - "default": DefaultApi, "fake": FakeApi, + "$another-fake?": AnotherFakeApi, "pet": PetApi, "fake_classname_tags 123#$%^": FakeClassnameTags123Api, - "user": UserApi, + "default": DefaultApi, "store": StoreApi, - "$another-fake?": AnotherFakeApi, + "user": UserApi, } ) diff --git a/src/main/java/org/openapijsonschematools/codegen/generatorrunner/DefaultGeneratorRunner.java b/src/main/java/org/openapijsonschematools/codegen/generatorrunner/DefaultGeneratorRunner.java index e48d3835c53..22b00de85db 100644 --- a/src/main/java/org/openapijsonschematools/codegen/generatorrunner/DefaultGeneratorRunner.java +++ b/src/main/java/org/openapijsonschematools/codegen/generatorrunner/DefaultGeneratorRunner.java @@ -1113,7 +1113,7 @@ void generateApis(List files, TreeMap paths) } } - HashMap>> tagToPathToOperations = new HashMap<>(); + LinkedHashMap>> tagToPathToOperations = new LinkedHashMap<>(); HashMap>> tagToOperationIdToPathToOperation = new HashMap<>(); Map apiPathTemplates = generator.jsonPathTemplateFiles().get(CodegenConstants.JSON_PATH_LOCATION_TYPE.API_PATH); for(Map.Entry entry: paths.entrySet()) { diff --git a/src/main/java/org/openapijsonschematools/codegen/generators/openapimodels/CodegenText.java b/src/main/java/org/openapijsonschematools/codegen/generators/openapimodels/CodegenText.java index 99aa6493237..7f513ce9d84 100644 --- a/src/main/java/org/openapijsonschematools/codegen/generators/openapimodels/CodegenText.java +++ b/src/main/java/org/openapijsonschematools/codegen/generators/openapimodels/CodegenText.java @@ -1,14 +1,20 @@ package org.openapijsonschematools.codegen.generators.openapimodels; +import com.github.jknack.handlebars.Handlebars; + import java.util.Objects; public class CodegenText { public final String original; public final String codeEscaped; + public final Handlebars.SafeString originalWithBr; public CodegenText(String original, String codeEscaped) { this.original = original; this.codeEscaped = codeEscaped; + String escaped = (String) Handlebars.Utils.escapeExpression(original); + escaped = escaped.replaceAll("(\r\n|\n)", "
"); + this.originalWithBr = new Handlebars.SafeString(escaped); } @Override @@ -17,7 +23,8 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) return false; CodegenText that = (CodegenText) o; return Objects.equals(original, that.original) && - Objects.equals(codeEscaped, that.codeEscaped); + Objects.equals(codeEscaped, that.codeEscaped) && + Objects.equals(originalWithBr, that.originalWithBr); } @Override @@ -25,12 +32,13 @@ public String toString() { final StringBuilder sb = new StringBuilder("CodegenText{"); sb.append("original=").append(original); sb.append(", codeEscaped=").append(codeEscaped); + sb.append(", originalWithBr=").append(originalWithBr); sb.append('}'); return sb.toString(); } @Override public int hashCode() { - return Objects.hash(original, codeEscaped); + return Objects.hash(original, codeEscaped, originalWithBr); } } diff --git a/src/main/resources/java/README.hbs b/src/main/resources/java/README.hbs index 6c9e756b027..c16200dada5 100644 --- a/src/main/resources/java/README.hbs +++ b/src/main/resources/java/README.hbs @@ -164,7 +164,7 @@ allowed input and output types. | ----- | ----------- | {{#each schemas}} {{#with this}} -| [{{containerJsonPathPiece.camelCase}}.{{jsonPathPiece.camelCase}}](docs/components/schemas/{{containerJsonPathPiece.camelCase}}.md#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.original}}{{/if}} | +| [{{containerJsonPathPiece.camelCase}}.{{jsonPathPiece.camelCase}}](docs/components/schemas/{{containerJsonPathPiece.camelCase}}.md#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.originalWithBr}}{{/if}} | {{/with}} {{/each}} {{/if}} diff --git a/src/main/resources/java/src/main/java/packagename/components/schemas/Schema_doc.hbs b/src/main/resources/java/src/main/java/packagename/components/schemas/Schema_doc.hbs index cb81e3d2d25..b05e829f2bb 100644 --- a/src/main/resources/java/src/main/java/packagename/components/schemas/Schema_doc.hbs +++ b/src/main/resources/java/src/main/java/packagename/components/schemas/Schema_doc.hbs @@ -42,7 +42,7 @@ A schema class that validates payloads {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if isCustomSchema}} {{#if typeToExample}} @@ -116,17 +116,17 @@ type: Map | Key | Type | Description | Notes | | --- | ---- | ------------ | ----- | {{#each requiredProperties}} -| **{{@key.original}}** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | {{#if description}}{{description.original}}{{/if}} |{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | +| **{{@key.original}}** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | {{/each}} {{#each optionalProperties}} -| **{{@key.original}}** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | {{#if description}}{{description.original}}{{/if}} | [optional]{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | +| **{{@key.original}}** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | {{#if description}}{{description.originalWithBr}}{{/if}} | [optional]{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | {{/each}} {{#with additionalProperties}} {{#unless isBooleanSchemaFalse}} {{#if isBooleanSchemaTrue}} -| **anyStringName** | Object | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional] | +| **anyStringName** | Object | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional] | {{else}} -| **anyStringName** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional]{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | +| **anyStringName** | {{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath }} | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional]{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} | {{/if}} {{/unless}} {{else}} @@ -154,7 +154,7 @@ type: List<{{#with items}}{{> src/main/java/packagename/components/schemas/types List Item Type | Description | Notes -------------------- | ------------- | ------------- {{#with items}} -{{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath forceNull=true }} | {{#if description}}{{description.original}}{{/if}} |{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} +{{> src/main/java/packagename/components/schemas/types/schema_input_type sourceJsonPath=../jsonPath forceNull=true }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> src/main/java/packagename/components/schemas/helpers/notes_msg defaultUser="server" }} {{/with}} {{/eq}} {{/eq}} diff --git a/src/main/resources/python/_helper_readme_common.hbs b/src/main/resources/python/_helper_readme_common.hbs index 1448567d823..09915d8e1ce 100644 --- a/src/main/resources/python/_helper_readme_common.hbs +++ b/src/main/resources/python/_helper_readme_common.hbs @@ -13,7 +13,7 @@ server_index | Class | Description ------------ | ----- | ------------ {{#each servers}} -{{@key}} | [{{jsonPathPiece.camelCase}}](docs/servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +{{@key}} | [{{jsonPathPiece.camelCase}}](docs/servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/each}} {{/if}} {{#if security}} @@ -43,7 +43,7 @@ HTTP request | Method | Description ------------ | ------ | ------------- {{#each paths}} {{#each operations}} -{{../@key.original}} **{{@key.original}}** | {{#each tags}}[{{className}}]({{apiDocPath}}{{moduleName}}.md).[{{operationId.snakeCase}}](docs/paths/{{../../@key.snakeCase}}/{{../@key.original}}.md) {{/each}} | {{#if summary}}{{summary.original}}{{/if}} +{{../@key.original}} **{{@key.original}}** | {{#each tags}}[{{className}}]({{apiDocPath}}{{moduleName}}.md).[{{operationId.snakeCase}}](docs/paths/{{../../@key.snakeCase}}/{{../@key.original}}.md) {{/each}} | {{#if summary}}{{summary.originalWithBr}}{{/if}} {{/each}} {{/each}} {{/if}} @@ -55,7 +55,7 @@ Class | Description ----- | ------------ {{#each schemas}} {{#with this}} -[{{jsonPathPiece.camelCase}}]({{modelDocPath}}{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}]({{modelDocPath}}{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} @@ -67,7 +67,7 @@ Class | Description ----- | ------------ {{#each requestBodies}} {{#with this}} -[{{jsonPathPiece.camelCase}}](docs/components/request_bodies/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}](docs/components/request_bodies/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} @@ -79,7 +79,7 @@ Class | Description ----- | ------------ {{#each responses}} {{#with this}} -[{{jsonPathPiece.camelCase}}](docs/components/responses/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}](docs/components/responses/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} @@ -91,7 +91,7 @@ Class | Description ----- | ------------ {{#each headers}} {{#with this}} -[{{jsonPathPiece.camelCase}}](docs/components/headers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}](docs/components/headers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} @@ -103,7 +103,7 @@ Class | Description ----- | ------------ {{#each parameters}} {{#with this}} -[{{jsonPathPiece.camelCase}}](docs/components/parameters/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}](docs/components/parameters/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} @@ -115,7 +115,7 @@ Class | Description ----- | ------------ {{#each securitySchemes}} {{#with this}} -[{{jsonPathPiece.camelCase}}](docs/components/security_schemes/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +[{{jsonPathPiece.camelCase}}](docs/components/security_schemes/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/with}} {{/each}} diff --git a/src/main/resources/python/apis/tags/api_doc.hbs b/src/main/resources/python/apis/tags/api_doc.hbs index 21a2e4eb88a..a60b0f00334 100644 --- a/src/main/resources/python/apis/tags/api_doc.hbs +++ b/src/main/resources/python/apis/tags/api_doc.hbs @@ -5,7 +5,7 @@ {{#if description}} ## Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{/with}} @@ -18,7 +18,7 @@ Method | Description ------ | ------------- {{#each operationIdToPathToOperation}} {{#each this}} -[**{{../@key.snakeCase}}**](../../paths/{{@key.snakeCase}}/{{jsonPathPiece.original}}.md) | {{#if summary}}{{summary.original}}{{/if}} +[**{{../@key.snakeCase}}**](../../paths/{{@key.snakeCase}}/{{jsonPathPiece.original}}.md) | {{#if summary}}{{summary.originalWithBr}}{{/if}} {{/each}} {{/each}} diff --git a/src/main/resources/python/components/headers/header_doc.hbs b/src/main/resources/python/components/headers/header_doc.hbs index 7cc7cd4c89a..db19887b217 100644 --- a/src/main/resources/python/components/headers/header_doc.hbs +++ b/src/main/resources/python/components/headers/header_doc.hbs @@ -10,7 +10,7 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} {{#with getDeepestRef}} @@ -19,7 +19,7 @@ {{> components/_helper_header_from_identifier_pieces headerSize=(join headerSize "#" "") identifierPieces=(append (newArray ) jsonPathPiece) }} Ref Class | Input Type | Accessed Type | Description --------- | ---------- | ------------- | ------------ -[{{../../refInfo.refClass}}.schema](../../components/headers/{{../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../description}}{{../../description.original}}{{/if}} +[{{../../refInfo.refClass}}.schema](../../components/headers/{{../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../description}}{{../../description.originalWithBr}}{{/if}} {{/with}} {{/if}} {{#each content}} @@ -36,7 +36,7 @@ Content-Type | Schema {{> components/_helper_header_from_identifier_pieces headerSize=(join headerSize "#" "") identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }} Ref Class | Input Type | Accessed Type | Description --------- | ---------- | ------------- | ------------ -[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/headers/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.original}}{{/if}} +[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/headers/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/with}} diff --git a/src/main/resources/python/components/parameters/parameter_doc.hbs b/src/main/resources/python/components/parameters/parameter_doc.hbs index d0ff37e8aea..44f5a555823 100644 --- a/src/main/resources/python/components/parameters/parameter_doc.hbs +++ b/src/main/resources/python/components/parameters/parameter_doc.hbs @@ -10,7 +10,7 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} {{#with getDeepestRef}} @@ -19,7 +19,7 @@ {{> components/_helper_header_from_identifier_pieces headerSize=(join headerSize "#" "") identifierPieces=(append (newArray ) jsonPathPiece) }} Ref Class | Input Type | Accessed Type | Description --------- | ---------- | ------------- | ------------ -[{{../../refInfo.refClass}}.schema](../../components/parameters/{{../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../description}}{{../../description.original}}{{/if}} +[{{../../refInfo.refClass}}.schema](../../components/parameters/{{../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../description}}{{../../description.originalWithBr}}{{/if}} {{/with}} {{else}} {{#each getDeepestRef.content}} @@ -36,7 +36,7 @@ Content-Type | Schema {{> components/_helper_header_from_identifier_pieces headerSize=(join headerSize "#" "") identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }} Ref Class | Input Type | Accessed Type | Description --------- | ---------- | ------------- | ------------ -[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/parameters/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.original}}{{/if}} +[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/parameters/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/if}} diff --git a/src/main/resources/python/components/request_bodies/request_body_doc.hbs b/src/main/resources/python/components/request_bodies/request_body_doc.hbs index 3212d13f91c..001606b10c9 100644 --- a/src/main/resources/python/components/request_bodies/request_body_doc.hbs +++ b/src/main/resources/python/components/request_bodies/request_body_doc.hbs @@ -10,7 +10,7 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} {{#with getDeepestRef}} @@ -29,7 +29,7 @@ Content-Type | Schema {{> components/_helper_header_from_identifier_pieces headerSize=(join headerSize "#" "") identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }} Ref Class | Input Type | Accessed Type | Description --------- | ---------- | ------------- | ------------ -[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.original}}{{/if}} +[{{../../../refInfo.refClass}}.content.{{../@key.snakeCase}}.schema](../../components/request_bodies/{{../../../refInfo.refModule}}.md#{{> components/_helper_anchor_id identifierPieces=(append (newArray ) "content" ../@key jsonPathPiece) }}) | {{> _helper_schema_python_types }} | {{> components/_helper_schema_accessed_types }} | {{#if ../../../description}}{{../../../description.originalWithBr}}{{/if}} {{/with}} {{/each}} {{/with}} diff --git a/src/main/resources/python/components/responses/response_doc.hbs b/src/main/resources/python/components/responses/response_doc.hbs index 6f14b57a590..ef614838978 100644 --- a/src/main/resources/python/components/responses/response_doc.hbs +++ b/src/main/resources/python/components/responses/response_doc.hbs @@ -10,7 +10,7 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} diff --git a/src/main/resources/python/components/schemas/schema_doc.hbs b/src/main/resources/python/components/schemas/schema_doc.hbs index 03335d4cefd..7373d0b0b9b 100644 --- a/src/main/resources/python/components/schemas/schema_doc.hbs +++ b/src/main/resources/python/components/schemas/schema_doc.hbs @@ -17,7 +17,7 @@ type: schemas.Schema {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} @@ -115,17 +115,17 @@ type: typing.Mapping[str, schemas.INPUT_TYPES_ALL] Key | Type | Description | Notes ------------ | ------------- | ------------- | ------------- {{#each requiredProperties}} -**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.original}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/each}} {{#each optionalProperties}} -**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.original}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/each}} {{#with additionalProperties}} {{#unless isBooleanSchemaFalse}} {{#if isBooleanSchemaTrue}} -**any_string_name** | {{> _helper_schema_python_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional] +**any_string_name** | {{> _helper_schema_python_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional] {{else}} -**any_string_name** | {{> components/schemas/types/docschema_io_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**any_string_name** | {{> components/schemas/types/docschema_io_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/if}} {{/unless}} {{else}} @@ -149,24 +149,24 @@ Keyword Argument | Type | Description | Notes ---------------- | ---- | ----------- | ----- {{#each requiredProperties}} {{#if @key.isValid}} -**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.original}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/if}} {{/each}} {{#each optionalProperties}} {{#if @key.isValid}} -**{{@key.original}}** | {{> components/schemas/types/docschema_io_types optional=true }} | {{#if description}}{{description.original}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_io_types optional=true }} | {{#if description}}{{description.originalWithBr}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/if}} {{/each}} {{#with additionalProperties}} {{#unless isBooleanSchemaFalse}} {{#if isBooleanSchemaTrue}} -**kwargs** | {{> _helper_schema_python_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional] typed value is accessed with the get_additional_property_ method +**kwargs** | {{> _helper_schema_python_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional] typed value is accessed with the get_additional_property_ method {{else}} -**kwargs** | {{> components/schemas/types/docschema_io_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} typed value is accessed with the get_additional_property_ method +**kwargs** | {{> components/schemas/types/docschema_io_types }} | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} typed value is accessed with the get_additional_property_ method {{/if}} {{/unless}} {{else}} -**kwargs** | schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO | any string name can be used but the value must be the correct type{{#if description}} {{description.original}}{{/if}} | [optional] typed value is accessed with the get_additional_property_ method +**kwargs** | schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO | any string name can be used but the value must be the correct type{{#if description}} {{description.originalWithBr}}{{/if}} | [optional] typed value is accessed with the get_additional_property_ method {{/with}} {{#or (and requiredProperties requiredProperties.hasValidKey) (and optionalProperties optionalProperties.hasValidKey) }} @@ -175,12 +175,12 @@ Property | Type | Description | Notes -------- | ---- | ----------- | ----- {{#each requiredProperties}} {{#if @key.isValid}} -**{{@key.original}}** | {{> components/schemas/types/docschema_output_types }} | {{#if description}}{{description.original}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_output_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/if}} {{/each}} {{#each optionalProperties}} {{#if @key.isValid}} -**{{@key.original}}** | {{> components/schemas/types/docschema_output_types optional=true }} | {{#if description}}{{description.original}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} +**{{@key.original}}** | {{> components/schemas/types/docschema_output_types optional=true }} | {{#if description}}{{description.originalWithBr}}{{/if}} | [optional]{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/if}} {{/each}} {{/or}} @@ -229,7 +229,7 @@ type: typing.Union[ List/Tuple Item Type | Description | Notes -------------------- | ------------- | ------------- {{#with items}} -{{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.original}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} +{{> components/schemas/types/docschema_io_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} |{{> components/schemas/helpers/notes_msg defaultUser="server" }} {{/with}} {{#if arrayOutputJsonPathPiece}} diff --git a/src/main/resources/python/components/security_schemes/security_scheme_doc.hbs b/src/main/resources/python/components/security_schemes/security_scheme_doc.hbs index a7138c5408d..050c1ccbdd0 100644 --- a/src/main/resources/python/components/security_schemes/security_scheme_doc.hbs +++ b/src/main/resources/python/components/security_schemes/security_scheme_doc.hbs @@ -8,12 +8,12 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} | Ref Class | Description | | --------- | ----------- | -| [{{refInfo.refClass}}](../../components/security_schemes/{{refInfo.refModule}}.{{refInfo.refClass}}.md#) |{{#with getDeepestRef}}{{#if description}} {{description.original}}{{/if}}{{/with}} +| [{{refInfo.refClass}}](../../components/security_schemes/{{refInfo.refModule}}.{{refInfo.refClass}}.md#) |{{#with getDeepestRef}}{{#if description}} {{description.originalWithBr}}{{/if}}{{/with}} {{else}} {{headerSize}}# Type diff --git a/src/main/resources/python/paths/path/verb/operation_doc.hbs b/src/main/resources/python/paths/path/verb/operation_doc.hbs index d1b155aa89e..8177936469c 100644 --- a/src/main/resources/python/paths/path/verb/operation_doc.hbs +++ b/src/main/resources/python/paths/path/verb/operation_doc.hbs @@ -32,10 +32,10 @@ | Field | Value | | ----- | ----- | {{#if summary}} -| Summary | {{summary.original}} | +| Summary | {{summary.originalWithBr}} | {{/if}} {{#if description}} -| Description | {{description.original}} | +| Description | {{description.originalWithBr}} | {{/if}} | Path | "{{{path.original}}}" | | HTTP Method | {{{httpMethod.original}}} | @@ -129,17 +129,17 @@ n/a | api_response.ApiResponseWithoutDeserialization | When skip_deserialization {{#if defaultResponse}} {{#with defaultResponse}} {{#if refInfo}} -default | [{{refInfo.refClass}}.ApiResponse](../../components/responses/{{refInfo.refModule}}.md#apiresponse) | {{#with getDeepestRef}}{{description.original}}{{/with}} +default | [{{refInfo.refClass}}.ApiResponse](../../components/responses/{{refInfo.refModule}}.md#apiresponse) | {{#with getDeepestRef}}{{description.originalWithBr}}{{/with}} {{else}} -default | [{{jsonPathPiece.camelCase}}.ApiResponse](#{{jsonPathPiece.anchorPiece}}-apiresponse) | {{description.original}} +default | [{{jsonPathPiece.camelCase}}.ApiResponse](#{{jsonPathPiece.anchorPiece}}-apiresponse) | {{description.originalWithBr}} {{/if}} {{/with}} {{/if}} {{#each nonDefaultResponses}} {{#if refInfo}} -{{@key}} | [{{refInfo.refClass}}.ApiResponse](../../components/responses/{{refInfo.refModule}}.md#apiresponse) | {{#with getDeepestRef}}{{description.original}}{{/with}} +{{@key}} | [{{refInfo.refClass}}.ApiResponse](../../components/responses/{{refInfo.refModule}}.md#apiresponse) | {{#with getDeepestRef}}{{description.originalWithBr}}{{/with}} {{else}} -{{@key}} | [{{jsonPathPiece.camelCase}}.ApiResponse](#{{jsonPathPiece.anchorPiece}}-apiresponse) | {{description.original}} +{{@key}} | [{{jsonPathPiece.camelCase}}.ApiResponse](#{{jsonPathPiece.anchorPiece}}-apiresponse) | {{description.originalWithBr}} {{/if}} {{/each}} {{#each responses}} @@ -220,16 +220,16 @@ server_index | Class | Description ------------ | ----- | ------------ {{#if servers}} {{#each servers}} -{{@key}} | [{{jsonPathPiece.camelCase}}](#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.original}}{{/if}} +{{@key}} | [{{jsonPathPiece.camelCase}}](#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/each}} {{else}} {{#if pathItem.servers}} {{#each pathItem.servers}} -{{@key}} | [{{jsonPathPiece.camelCase}}](#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.original}}{{/if}} +{{@key}} | [{{jsonPathPiece.camelCase}}](#{{jsonPathPiece.anchorPiece}}) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/each}} {{else}} {{#each ../servers}} -{{@key}} | [{{jsonPathPiece.camelCase}}](../../servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.original}}{{/if}} +{{@key}} | [{{jsonPathPiece.camelCase}}](../../servers/{{jsonPathPiece.snakeCase}}.md) |{{#if description}} {{description.originalWithBr}}{{/if}} {{/each}} {{/if}} {{/if}} diff --git a/src/main/resources/python/servers/server_doc.hbs b/src/main/resources/python/servers/server_doc.hbs index 3bff82e855a..821a36b0e42 100644 --- a/src/main/resources/python/servers/server_doc.hbs +++ b/src/main/resources/python/servers/server_doc.hbs @@ -10,12 +10,12 @@ {{#if description}} {{headerSize}}# Description -{{description.original}} +{{description.originalWithBr}} {{/if}} {{#if refInfo}} | Ref Class | Description | | --------- | ----------- | -| [{{refInfo.refClass}}](../../servers/{{refInfo.refModule}}.{{refInfo.refClass}}.md#) |{{#with getDeepestRef}}{{#if description}} {{description.original}}{{/if}}{{/with}} +| [{{refInfo.refClass}}](../../servers/{{refInfo.refModule}}.{{refInfo.refClass}}.md#) |{{#with getDeepestRef}}{{#if description}} {{description.originalWithBr}}{{/if}}{{/with}} {{else}} {{headerSize}}# Url @@ -27,7 +27,7 @@ Key | Type | Description | Notes --- | ---- | ----------- | ------ {{#with variables}} {{#each properties}} -**{{@key.original}}** | {{> _helper_schema_python_types }} | {{#if description}}{{description.original}}{{/if}} | {{> components/schemas/helpers/notes_msg defaultUser="client" }} +**{{@key.original}}** | {{> _helper_schema_python_types }} | {{#if description}}{{description.originalWithBr}}{{/if}} | {{> components/schemas/helpers/notes_msg defaultUser="client" }} {{/each}} {{/with}} {{/if}}