From 679bf222a76262daf97402befdb10bfe5bfcd3ea Mon Sep 17 00:00:00 2001 From: vyaivanove Date: Wed, 28 Feb 2024 17:23:07 +0300 Subject: [PATCH] Add documentation update to release flow 6f6901f1f0bf2098ff8439b0cc48c524016219ba --- .../generators/documentation/generator.py | 28 ++-- .../generators/documentation/translations.py | 4 + .../documentation/en/entity_with_array.md | 19 ++- .../en/entity_with_array_of_enums.md | 19 ++- .../en/entity_with_array_of_expressions.md | 19 ++- .../en/entity_with_array_of_nested_items.md | 31 ++-- .../en/entity_with_array_with_transform.md | 19 ++- .../en/entity_with_complex_property.md | 23 +-- ...ith_complex_property_with_default_value.md | 27 ++-- .../en/entity_with_entity_property.md | 17 ++- .../en/entity_with_json_property.md | 17 ++- .../entity_with_optional_complex_property.md | 27 ++-- .../en/entity_with_optional_property.md | 17 ++- ...tity_with_optional_string_enum_property.md | 17 ++- ...entity_with_property_with_default_value.md | 35 +++-- .../documentation/en/entity_with_raw_array.md | 19 ++- .../en/entity_with_required_property.md | 19 ++- .../en/entity_with_simple_properties.md | 33 ++-- .../en/entity_with_string_array_property.md | 19 ++- .../en/entity_with_string_enum_property.md | 19 ++- ...string_enum_property_with_default_value.md | 19 ++- .../en/entity_without_properties.md | 17 ++- .../documentation/en/with_default.md | 17 ++- .../documentation/en/without_default.md | 17 ++- .../documentation/ru/entity_with_array.md | 19 ++- .../ru/entity_with_array_of_enums.md | 19 ++- .../ru/entity_with_array_of_expressions.md | 19 ++- .../ru/entity_with_array_of_nested_items.md | 31 ++-- .../ru/entity_with_array_with_transform.md | 19 ++- .../ru/entity_with_complex_property.md | 23 +-- ...ith_complex_property_with_default_value.md | 27 ++-- .../ru/entity_with_entity_property.md | 17 ++- .../ru/entity_with_json_property.md | 17 ++- .../entity_with_optional_complex_property.md | 27 ++-- .../ru/entity_with_optional_property.md | 17 ++- ...tity_with_optional_string_enum_property.md | 17 ++- ...entity_with_property_with_default_value.md | 35 +++-- .../documentation/ru/entity_with_raw_array.md | 19 ++- .../ru/entity_with_required_property.md | 19 ++- .../ru/entity_with_simple_properties.md | 33 ++-- .../ru/entity_with_string_array_property.md | 19 ++- .../ru/entity_with_string_enum_property.md | 19 ++- ...string_enum_property_with_default_value.md | 19 ++- .../ru/entity_without_properties.md | 17 ++- .../documentation/ru/with_default.md | 17 ++- .../documentation/ru/without_default.md | 17 ++- .../tests/references/documentation/toc.yaml | 144 +++++++++--------- 47 files changed, 627 insertions(+), 481 deletions(-) diff --git a/api_generator/api_generator/generators/documentation/generator.py b/api_generator/api_generator/generators/documentation/generator.py index 6db0541ca..1c4a617fb 100644 --- a/api_generator/api_generator/generators/documentation/generator.py +++ b/api_generator/api_generator/generators/documentation/generator.py @@ -64,10 +64,10 @@ class DocumentationGenerator(Generator): @staticmethod def __menu_item(obj: DocumentationDeclarable) -> str: - toc = '' if obj.include_in_documentation_toc else '\n hidden: true' + toc = '' if obj.include_in_documentation_toc else '\n hidden: true' return '\n'.join([ - f' -name: {obj.name}', - f' href: concepts/divs/{obj.name}.md{toc}' + f' - name: {obj.name}', + f' href: concepts/divs/2/{obj.name}.md{toc}' ]) def filename(self, name: str) -> str: @@ -83,13 +83,16 @@ class DocumentationGenerator(Generator): return Text([ f'# {header}', '', - '## JSON', + f'## {params_header}', + self.__fields_table(entity), + '', + '
', + 'JSON', + '', '```json', str(entity.json_description(obj_stack=[])), '```', - '', - f'## {params_header}', - self.__fields_table(entity) + '
', ]) def __description(self, entity: DocumentationEntity) -> str: @@ -103,7 +106,7 @@ class DocumentationGenerator(Generator): properties_table_content = Text(list(map( lambda p: f'| {code(p.dict_field)} | {self.__table_description(p)} |', - entity.properties_doc + sorted(entity.properties_doc, key=lambda x: x.optional) ))) inner_types_tables = '\n\n'.join(map( @@ -173,4 +176,11 @@ class DocumentationGenerator(Generator): ]) def _string_enumeration_declaration(self, string_enumeration: StringEnumeration) -> Text: - return Text() + header = self.__translations['div_generator_string_enumeration'] + enumeration = '\n'.join(map(lambda entity: f'* {entity[0]}', + string_enumeration.cases)) + return Text([ + f'# {string_enumeration.name}', + header, + enumeration + ]) diff --git a/api_generator/api_generator/generators/documentation/translations.py b/api_generator/api_generator/generators/documentation/translations.py index 5dcdea375..43c3d7cd2 100644 --- a/api_generator/api_generator/generators/documentation/translations.py +++ b/api_generator/api_generator/generators/documentation/translations.py @@ -26,6 +26,10 @@ __full_translations: Dict[str, Dict[str, str]] = { "en": "Can have one of the following types:", "ru": "Может иметь один из следующих типов:" }, + "div_generator_string_enumeration": { + "en": "Can have one of the following values:", + "ru": "Может иметь одно из следующих значений:" + }, "div_generator_factory_method_name": { "en": "Can be created using the method [{}].", "ru": "Можно создать при помощи метода [{}]." diff --git a/api_generator/tests/references/documentation/en/entity_with_array.md b/api_generator/tests/references/documentation/en/entity_with_array.md index 4c64626ac..3066db709 100644 --- a/api_generator/tests/references/documentation/en/entity_with_array.md +++ b/api_generator/tests/references/documentation/en/entity_with_array.md @@ -1,16 +1,19 @@ # entity_with_array No description yet. -## JSON -```json -{ - type*: "entity_with_array", - array*: [ entity, ... ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `array` |

**array**

Required parameter.

An array must not be empty.

List of possible values:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_array`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array", + array*: [ entity, ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_array_of_enums.md b/api_generator/tests/references/documentation/en/entity_with_array_of_enums.md index d50d7d6bc..4442168f3 100644 --- a/api_generator/tests/references/documentation/en/entity_with_array_of_enums.md +++ b/api_generator/tests/references/documentation/en/entity_with_array_of_enums.md @@ -1,16 +1,19 @@ # entity_with_array_of_enums No description yet. -## JSON -```json -{ - type*: "entity_with_array_of_enums", - items*: [ "string", ... ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `items` |

    **array**

    Required parameter.

    An array must not be empty.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_array_of_enums`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_enums", + items*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_array_of_expressions.md b/api_generator/tests/references/documentation/en/entity_with_array_of_expressions.md index 996be6c31..c92a72610 100644 --- a/api_generator/tests/references/documentation/en/entity_with_array_of_expressions.md +++ b/api_generator/tests/references/documentation/en/entity_with_array_of_expressions.md @@ -1,16 +1,19 @@ # entity_with_array_of_expressions No description yet. -## JSON -```json -{ - type*: "entity_with_array_of_expressions", - items*: [ "string", ... ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `items` |

    **array**

    Required parameter.

    An array must not be empty.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_array_of_expressions`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_expressions", + items*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_array_of_nested_items.md b/api_generator/tests/references/documentation/en/entity_with_array_of_nested_items.md index aa421a870..5e6383998 100644 --- a/api_generator/tests/references/documentation/en/entity_with_array_of_nested_items.md +++ b/api_generator/tests/references/documentation/en/entity_with_array_of_nested_items.md @@ -1,20 +1,6 @@ # entity_with_array_of_nested_items No description yet. -## JSON -```json -{ - type*: "entity_with_array_of_nested_items", - items*: [ - { - entity*: entity, - property*: "string" - }, - ... - ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | @@ -26,3 +12,20 @@ No description yet. | --- | --- | | `entity` |

    **object**

    Required parameter.

    The value has the type `entity`.

    List of possible values:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | | `property` |

    **string**

    Required parameter.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_nested_items", + items*: [ + { + entity*: entity, + property*: "string" + }, + ... + ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_array_with_transform.md b/api_generator/tests/references/documentation/en/entity_with_array_with_transform.md index 3ea7521ec..82fbd6113 100644 --- a/api_generator/tests/references/documentation/en/entity_with_array_with_transform.md +++ b/api_generator/tests/references/documentation/en/entity_with_array_with_transform.md @@ -1,16 +1,19 @@ # entity_with_array_with_transform No description yet. -## JSON -```json -{ - type*: "entity_with_array_with_transform", - array*: [ "string", ... ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `array` |

    **array**

    Required parameter.

    An array must not be empty.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_array_with_transform`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_with_transform", + array*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_complex_property.md b/api_generator/tests/references/documentation/en/entity_with_complex_property.md index 2c626288b..a73c312cb 100644 --- a/api_generator/tests/references/documentation/en/entity_with_complex_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_complex_property.md @@ -1,16 +1,6 @@ # entity_with_complex_property No description yet. -## JSON -```json -{ - type*: "entity_with_complex_property", - property*: { - value*: "string" - } -} -``` - ## Parameters | Parameters | Description | | --- | --- | @@ -21,3 +11,16 @@ No description yet. | Parameters | Description | | --- | --- | | `value` |

    **string**

    Required parameter.

    The value must be a valid URL.

    | + +
    +JSON + +```json +{ + type*: "entity_with_complex_property", + property*: { + value*: "string" + } +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_complex_property_with_default_value.md b/api_generator/tests/references/documentation/en/entity_with_complex_property_with_default_value.md index a9be98ab6..6356a06e7 100644 --- a/api_generator/tests/references/documentation/en/entity_with_complex_property_with_default_value.md +++ b/api_generator/tests/references/documentation/en/entity_with_complex_property_with_default_value.md @@ -1,7 +1,20 @@ # entity_with_complex_property_with_default_value No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_complex_property_with_default_value`.

    | +| `property` |

    **object**

    The value has the type `property`.

    Default value: `{ "value": "Default text" }`.

    | + +### property +| Parameters | Description | +| --- | --- | +| `value` |

    **string**

    Required parameter.

    | + +
    +JSON + ```json { type*: "entity_with_complex_property_with_default_value", @@ -10,14 +23,4 @@ No description yet. } } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `property` |

    **object**

    The value has the type `property`.

    Default value: `{ "value": "Default text" }`.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_complex_property_with_default_value`.

    | - -### property -| Parameters | Description | -| --- | --- | -| `value` |

    **string**

    Required parameter.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_entity_property.md b/api_generator/tests/references/documentation/en/entity_with_entity_property.md index 71a502a9c..caf151d3f 100644 --- a/api_generator/tests/references/documentation/en/entity_with_entity_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_entity_property.md @@ -1,16 +1,19 @@ # entity_with_entity_property No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_entity_property`.

    | +| `entity` |

    **object**

    The value has the type `entity`.

    Default value: `{ "type": "entity_with_string_enum_property", "property": "second" }`.

    List of possible values:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | + +
    +JSON + ```json { type*: "entity_with_entity_property", entity: entity } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `entity` |

    **object**

    The value has the type `entity`.

    Default value: `{ "type": "entity_with_string_enum_property", "property": "second" }`.

    List of possible values:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_entity_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_json_property.md b/api_generator/tests/references/documentation/en/entity_with_json_property.md index 609f044fb..3ec7487e1 100644 --- a/api_generator/tests/references/documentation/en/entity_with_json_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_json_property.md @@ -1,16 +1,19 @@ # entity_with_json_property No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_json_property`.

    | +| `json_property` |

    **object**

    Default value: `{

    "key": "value",

    "items": [

    "value"

    ]

    }`.

    | + +
    +JSON + ```json { type*: "entity_with_json_property", json_property: "object" } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `json_property` |

    **object**

    Default value: `{

    "key": "value",

    "items": [

    "value"

    ]

    }`.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_json_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_optional_complex_property.md b/api_generator/tests/references/documentation/en/entity_with_optional_complex_property.md index f3876437a..bdd8f99c6 100644 --- a/api_generator/tests/references/documentation/en/entity_with_optional_complex_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_optional_complex_property.md @@ -1,7 +1,20 @@ # entity_with_optional_complex_property No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_complex_property`.

    | +| `property` |

    **object**

    The value has the type `property`.

    | + +### property +| Parameters | Description | +| --- | --- | +| `value` |

    **string**

    Required parameter.

    The value must be a valid URL.

    | + +
    +JSON + ```json { type*: "entity_with_optional_complex_property", @@ -10,14 +23,4 @@ No description yet. } } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `property` |

    **object**

    The value has the type `property`.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_complex_property`.

    | - -### property -| Parameters | Description | -| --- | --- | -| `value` |

    **string**

    Required parameter.

    The value must be a valid URL.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_optional_property.md b/api_generator/tests/references/documentation/en/entity_with_optional_property.md index bdccc82e3..091beb5bf 100644 --- a/api_generator/tests/references/documentation/en/entity_with_optional_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_optional_property.md @@ -1,16 +1,19 @@ # entity_with_optional_property No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_property`.

    | +| `property` |

    **string**

    | + +
    +JSON + ```json { type*: "entity_with_optional_property", property: "string" } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `property` |

    **string**

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_optional_string_enum_property.md b/api_generator/tests/references/documentation/en/entity_with_optional_string_enum_property.md index a9aca036c..817e537e5 100644 --- a/api_generator/tests/references/documentation/en/entity_with_optional_string_enum_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_optional_string_enum_property.md @@ -1,16 +1,19 @@ # entity_with_optional_string_enum_property No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_string_enum_property`.

    | +| `property` |

    **string**

    Possible values: `first`, `second`.

    | + +
    +JSON + ```json { type*: "entity_with_optional_string_enum_property", property: "string" } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `property` |

    **string**

    Possible values: `first`, `second`.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_optional_string_enum_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_property_with_default_value.md b/api_generator/tests/references/documentation/en/entity_with_property_with_default_value.md index d5aef70a3..358000210 100644 --- a/api_generator/tests/references/documentation/en/entity_with_property_with_default_value.md +++ b/api_generator/tests/references/documentation/en/entity_with_property_with_default_value.md @@ -1,7 +1,24 @@ # entity_with_property_with_default_value No description yet. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_property_with_default_value`.

    | +| `int` |

    **int**

    Restriction for the value `x`: `x >= 0`.

    Default value: `0`.

    | +| `nested` |

    **object**

    non_optional is used to suppress auto-generation of default value for object with all-optional fields.

    The value has the type `nested`.

    | +| `url` |

    **string**

    The value must be a valid URL.

    Allowed schemes: `https`.

    Default value: `https://yandex.ru`.

    | + +### nested +| Parameters | Description | +| --- | --- | +| `non_optional` |

    **string**

    Required parameter.

    | +| `int` |

    **int**

    Restriction for the value `x`: `x >= 0`.

    Default value: `0`.

    | +| `url` |

    **string**

    The value must be a valid URL.

    Allowed schemes: `https`.

    Default value: `https://yandex.ru`.

    | + +
    +JSON + ```json { type*: "entity_with_property_with_default_value", @@ -14,18 +31,4 @@ No description yet. url: "string" } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `int` |

    **int**

    Restriction for the value `x`: `x >= 0`.

    Default value: `0`.

    | -| `nested` |

    **object**

    non_optional is used to suppress auto-generation of default value for object with all-optional fields.

    The value has the type `nested`.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_property_with_default_value`.

    | -| `url` |

    **string**

    The value must be a valid URL.

    Allowed schemes: `https`.

    Default value: `https://yandex.ru`.

    | - -### nested -| Parameters | Description | -| --- | --- | -| `int` |

    **int**

    Restriction for the value `x`: `x >= 0`.

    Default value: `0`.

    | -| `non_optional` |

    **string**

    Required parameter.

    | -| `url` |

    **string**

    The value must be a valid URL.

    Allowed schemes: `https`.

    Default value: `https://yandex.ru`.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_raw_array.md b/api_generator/tests/references/documentation/en/entity_with_raw_array.md index 075c6f106..e52fb9f86 100644 --- a/api_generator/tests/references/documentation/en/entity_with_raw_array.md +++ b/api_generator/tests/references/documentation/en/entity_with_raw_array.md @@ -1,16 +1,19 @@ # entity_with_raw_array No description yet. -## JSON -```json -{ - type*: "entity_with_raw_array", - array*: "raw_array" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `array` |

    **raw_array**

    Required parameter.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_raw_array`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_raw_array", + array*: "raw_array" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_required_property.md b/api_generator/tests/references/documentation/en/entity_with_required_property.md index 4862f477b..cfbb6943e 100644 --- a/api_generator/tests/references/documentation/en/entity_with_required_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_required_property.md @@ -1,16 +1,19 @@ # entity_with_required_property No description yet. -## JSON -```json -{ - type*: "entity_with_required_property", - property*: "string" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `property` |

    **string**

    Required parameter.

    A string must not be empty.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_required_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_required_property", + property*: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_simple_properties.md b/api_generator/tests/references/documentation/en/entity_with_simple_properties.md index 6d1baf511..6527f875b 100644 --- a/api_generator/tests/references/documentation/en/entity_with_simple_properties.md +++ b/api_generator/tests/references/documentation/en/entity_with_simple_properties.md @@ -1,7 +1,23 @@ # entity_with_simple_properties Entity with simple properties. -## JSON +## Parameters +| Parameters | Description | +| --- | --- | +| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_simple_properties`.

    | +| `boolean` |

    **bool**

    Boolean property.

    | +| `boolean_int` |

    **bool_int**

    Parameter is deprecated.

    Boolean value in numeric format.

    Available platforms: Android.

    | +| `color` |

    **string**

    Color.

    Valid formats: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.

    | +| `double` |

    **number**

    Floating point number.

    | +| `id` |

    **int**

    ID. Can't contain expressions.

    Default value: `0`.

    | +| `integer` |

    **int**

    Integer.

    Default value: `0`.

    | +| `positive_integer` |

    **int**

    Positive integer.

    Restriction for the value `x`: `x > 0`.

    Functionality is under development.

    | +| `string` |

    **string**

    String.

    Available platforms: Android, iOS, web.

    | +| `url` |

    **string**

    The value must be a valid URL.

    | + +
    +JSON + ```json { type*: "entity_with_simple_properties", @@ -16,17 +32,4 @@ Entity with simple properties. url: "string" } ``` - -## Parameters -| Parameters | Description | -| --- | --- | -| `boolean` |

    **bool**

    Boolean property.

    | -| `boolean_int` |

    **bool_int**

    Parameter is deprecated.

    Boolean value in numeric format.

    Available platforms: Android.

    | -| `color` |

    **string**

    Color.

    Valid formats: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.

    | -| `double` |

    **number**

    Floating point number.

    | -| `id` |

    **int**

    ID. Can't contain expressions.

    Default value: `0`.

    | -| `integer` |

    **int**

    Integer.

    Default value: `0`.

    | -| `positive_integer` |

    **int**

    Positive integer.

    Restriction for the value `x`: `x > 0`.

    Functionality is under development.

    | -| `string` |

    **string**

    String.

    Available platforms: Android, iOS, web.

    | -| `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_simple_properties`.

    | -| `url` |

    **string**

    The value must be a valid URL.

    | +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_string_array_property.md b/api_generator/tests/references/documentation/en/entity_with_string_array_property.md index a1967c37f..0e243c5c1 100644 --- a/api_generator/tests/references/documentation/en/entity_with_string_array_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_string_array_property.md @@ -1,16 +1,19 @@ # entity_with_string_array_property No description yet. -## JSON -```json -{ - type*: "entity_with_string_array_property", - array*: [ "string", ... ] -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `array` |

    **array**

    Required parameter.

    An array must not be empty.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_string_array_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_array_property", + array*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_string_enum_property.md b/api_generator/tests/references/documentation/en/entity_with_string_enum_property.md index 3623e1795..e5e4071bf 100644 --- a/api_generator/tests/references/documentation/en/entity_with_string_enum_property.md +++ b/api_generator/tests/references/documentation/en/entity_with_string_enum_property.md @@ -1,16 +1,19 @@ # entity_with_string_enum_property No description yet. -## JSON -```json -{ - type*: "entity_with_string_enum_property", - property*: "string" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `property` |

    **string**

    Required parameter.

    Possible values: `first`, `second`.

    | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_string_enum_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_enum_property", + property*: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_with_string_enum_property_with_default_value.md b/api_generator/tests/references/documentation/en/entity_with_string_enum_property_with_default_value.md index 559bad522..6a1f2cc7d 100644 --- a/api_generator/tests/references/documentation/en/entity_with_string_enum_property_with_default_value.md +++ b/api_generator/tests/references/documentation/en/entity_with_string_enum_property_with_default_value.md @@ -1,16 +1,19 @@ # entity_with_string_enum_property_with_default_value No description yet. -## JSON -```json -{ - type*: "entity_with_string_enum_property_with_default_value", - value: "string" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_with_string_enum_property_with_default_value`.

    | | `value` |

    **string**

    Possible values: `first`, `second`, `third`.

    Default value: `second`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_enum_property_with_default_value", + value: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/entity_without_properties.md b/api_generator/tests/references/documentation/en/entity_without_properties.md index 355b0618b..1f7a9e5a3 100644 --- a/api_generator/tests/references/documentation/en/entity_without_properties.md +++ b/api_generator/tests/references/documentation/en/entity_without_properties.md @@ -1,14 +1,17 @@ # entity_without_properties No description yet. -## JSON -```json -{ - type*: "entity_without_properties" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `type` |

    **string**

    Required parameter.

    The value must always be `entity_without_properties`.

    | + +
    +JSON + +```json +{ + type*: "entity_without_properties" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/with_default.md b/api_generator/tests/references/documentation/en/with_default.md index c6cfebcdc..825977781 100644 --- a/api_generator/tests/references/documentation/en/with_default.md +++ b/api_generator/tests/references/documentation/en/with_default.md @@ -1,14 +1,17 @@ # with_default No description yet. -## JSON -```json -{ - type: "default" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `type` |

    **string**

    The value must always be `default`.

    | + +
    +JSON + +```json +{ + type: "default" +} +``` +
    diff --git a/api_generator/tests/references/documentation/en/without_default.md b/api_generator/tests/references/documentation/en/without_default.md index cc40a9a7e..6ecbb0ae5 100644 --- a/api_generator/tests/references/documentation/en/without_default.md +++ b/api_generator/tests/references/documentation/en/without_default.md @@ -1,14 +1,17 @@ # without_default No description yet. -## JSON -```json -{ - type*: "non_default" -} -``` - ## Parameters | Parameters | Description | | --- | --- | | `type` |

    **string**

    Required parameter.

    The value must always be `non_default`.

    | + +
    +JSON + +```json +{ + type*: "non_default" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_array.md b/api_generator/tests/references/documentation/ru/entity_with_array.md index 4639a45d6..aea1884cf 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_array.md +++ b/api_generator/tests/references/documentation/ru/entity_with_array.md @@ -1,16 +1,19 @@ # entity_with_array Описания пока нет. -## JSON -```json -{ - type*: "entity_with_array", - array*: [ entity, ... ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `array` |

    **array**

    Обязательный параметр.

    Массив должен быть непустым.

    Список возможных значений:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_array`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array", + array*: [ entity, ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_array_of_enums.md b/api_generator/tests/references/documentation/ru/entity_with_array_of_enums.md index 2c34b0850..229bd20bb 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_array_of_enums.md +++ b/api_generator/tests/references/documentation/ru/entity_with_array_of_enums.md @@ -1,16 +1,19 @@ # entity_with_array_of_enums Описания пока нет. -## JSON -```json -{ - type*: "entity_with_array_of_enums", - items*: [ "string", ... ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `items` |

    **array**

    Обязательный параметр.

    Массив должен быть непустым.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_array_of_enums`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_enums", + items*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_array_of_expressions.md b/api_generator/tests/references/documentation/ru/entity_with_array_of_expressions.md index c36df76a3..61e0f21b6 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_array_of_expressions.md +++ b/api_generator/tests/references/documentation/ru/entity_with_array_of_expressions.md @@ -1,16 +1,19 @@ # entity_with_array_of_expressions Описания пока нет. -## JSON -```json -{ - type*: "entity_with_array_of_expressions", - items*: [ "string", ... ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `items` |

    **array**

    Обязательный параметр.

    Массив должен быть непустым.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_array_of_expressions`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_expressions", + items*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_array_of_nested_items.md b/api_generator/tests/references/documentation/ru/entity_with_array_of_nested_items.md index a25b15455..5bdf36b70 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_array_of_nested_items.md +++ b/api_generator/tests/references/documentation/ru/entity_with_array_of_nested_items.md @@ -1,20 +1,6 @@ # entity_with_array_of_nested_items Описания пока нет. -## JSON -```json -{ - type*: "entity_with_array_of_nested_items", - items*: [ - { - entity*: entity, - property*: "string" - }, - ... - ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | @@ -26,3 +12,20 @@ | --- | --- | | `entity` |

    **object**

    Обязательный параметр.

    Значение имеет тип `entity`.

    Список возможных значений:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | | `property` |

    **string**

    Обязательный параметр.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_of_nested_items", + items*: [ + { + entity*: entity, + property*: "string" + }, + ... + ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_array_with_transform.md b/api_generator/tests/references/documentation/ru/entity_with_array_with_transform.md index 42bafdf68..0a0c61ab5 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_array_with_transform.md +++ b/api_generator/tests/references/documentation/ru/entity_with_array_with_transform.md @@ -1,16 +1,19 @@ # entity_with_array_with_transform Описания пока нет. -## JSON -```json -{ - type*: "entity_with_array_with_transform", - array*: [ "string", ... ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `array` |

    **array**

    Обязательный параметр.

    Массив должен быть непустым.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_array_with_transform`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_array_with_transform", + array*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_complex_property.md b/api_generator/tests/references/documentation/ru/entity_with_complex_property.md index 4cc28fd42..4b240243c 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_complex_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_complex_property.md @@ -1,16 +1,6 @@ # entity_with_complex_property Описания пока нет. -## JSON -```json -{ - type*: "entity_with_complex_property", - property*: { - value*: "string" - } -} -``` - ## Параметры | Параметры | Описание | | --- | --- | @@ -21,3 +11,16 @@ | Параметры | Описание | | --- | --- | | `value` |

    **string**

    Обязательный параметр.

    Значение должно быть валидным URL.

    | + +
    +JSON + +```json +{ + type*: "entity_with_complex_property", + property*: { + value*: "string" + } +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_complex_property_with_default_value.md b/api_generator/tests/references/documentation/ru/entity_with_complex_property_with_default_value.md index ebad2553d..498953597 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_complex_property_with_default_value.md +++ b/api_generator/tests/references/documentation/ru/entity_with_complex_property_with_default_value.md @@ -1,7 +1,20 @@ # entity_with_complex_property_with_default_value Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_complex_property_with_default_value`.

    | +| `property` |

    **object**

    Значение имеет тип `property`.

    Значение по умолчанию: `{ "value": "Default text" }`.

    | + +### property +| Параметры | Описание | +| --- | --- | +| `value` |

    **string**

    Обязательный параметр.

    | + +
    +JSON + ```json { type*: "entity_with_complex_property_with_default_value", @@ -10,14 +23,4 @@ } } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `property` |

    **object**

    Значение имеет тип `property`.

    Значение по умолчанию: `{ "value": "Default text" }`.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_complex_property_with_default_value`.

    | - -### property -| Параметры | Описание | -| --- | --- | -| `value` |

    **string**

    Обязательный параметр.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_entity_property.md b/api_generator/tests/references/documentation/ru/entity_with_entity_property.md index 52eefd800..07b800cd3 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_entity_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_entity_property.md @@ -1,16 +1,19 @@ # entity_with_entity_property Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_entity_property`.

    | +| `entity` |

    **object**

    Значение имеет тип `entity`.

    Значение по умолчанию: `{ "type": "entity_with_string_enum_property", "property": "second" }`.

    Список возможных значений:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | + +
    +JSON + ```json { type*: "entity_with_entity_property", entity: entity } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `entity` |

    **object**

    Значение имеет тип `entity`.

    Значение по умолчанию: `{ "type": "entity_with_string_enum_property", "property": "second" }`.

    Список возможных значений:

  • [entity_with_array](entity_with_array.md#entity_with_array)
  • [entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)
  • [entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)
  • [entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)
  • [entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)
  • [entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)
  • [entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)
  • [entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)
  • [entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)
  • [entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)
  • [entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)
  • [entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)
  • [entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)
  • [entity_with_required_property](entity_with_required_property.md#entity_with_required_property)
  • [entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)
  • [entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)
  • [entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)
  • [entity_with_string_enum_property_with_default_value](entity_with_string_enum_property_with_default_value.md#entity_with_string_enum_property_with_default_value)
  • [entity_without_properties](entity_without_properties.md#entity_without_properties)

    • | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_entity_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_json_property.md b/api_generator/tests/references/documentation/ru/entity_with_json_property.md index bd1470abb..127feffaf 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_json_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_json_property.md @@ -1,16 +1,19 @@ # entity_with_json_property Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_json_property`.

    | +| `json_property` |

    **object**

    Значение по умолчанию: `{

    "key": "value",

    "items": [

    "value"

    ]

    }`.

    | + +
    +JSON + ```json { type*: "entity_with_json_property", json_property: "object" } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `json_property` |

    **object**

    Значение по умолчанию: `{

    "key": "value",

    "items": [

    "value"

    ]

    }`.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_json_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_optional_complex_property.md b/api_generator/tests/references/documentation/ru/entity_with_optional_complex_property.md index 2d2ecf63c..89f394643 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_optional_complex_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_optional_complex_property.md @@ -1,7 +1,20 @@ # entity_with_optional_complex_property Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_complex_property`.

    | +| `property` |

    **object**

    Значение имеет тип `property`.

    | + +### property +| Параметры | Описание | +| --- | --- | +| `value` |

    **string**

    Обязательный параметр.

    Значение должно быть валидным URL.

    | + +
    +JSON + ```json { type*: "entity_with_optional_complex_property", @@ -10,14 +23,4 @@ } } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `property` |

    **object**

    Значение имеет тип `property`.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_complex_property`.

    | - -### property -| Параметры | Описание | -| --- | --- | -| `value` |

    **string**

    Обязательный параметр.

    Значение должно быть валидным URL.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_optional_property.md b/api_generator/tests/references/documentation/ru/entity_with_optional_property.md index b0a7b248c..58da6f5f2 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_optional_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_optional_property.md @@ -1,16 +1,19 @@ # entity_with_optional_property Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_property`.

    | +| `property` |

    **string**

    | + +
    +JSON + ```json { type*: "entity_with_optional_property", property: "string" } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `property` |

    **string**

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_optional_string_enum_property.md b/api_generator/tests/references/documentation/ru/entity_with_optional_string_enum_property.md index ce99cb252..f9d574435 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_optional_string_enum_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_optional_string_enum_property.md @@ -1,16 +1,19 @@ # entity_with_optional_string_enum_property Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_string_enum_property`.

    | +| `property` |

    **string**

    Возможные значения: `first`, `second`.

    | + +
    +JSON + ```json { type*: "entity_with_optional_string_enum_property", property: "string" } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `property` |

    **string**

    Возможные значения: `first`, `second`.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_optional_string_enum_property`.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_property_with_default_value.md b/api_generator/tests/references/documentation/ru/entity_with_property_with_default_value.md index 034793c7c..7b3d801cd 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_property_with_default_value.md +++ b/api_generator/tests/references/documentation/ru/entity_with_property_with_default_value.md @@ -1,7 +1,24 @@ # entity_with_property_with_default_value Описания пока нет. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_property_with_default_value`.

    | +| `int` |

    **int**

    Ограничение для значения `x`: `x >= 0`.

    Значение по умолчанию: `0`.

    | +| `nested` |

    **object**

    non_optional используется, чтобы запретить автогенерацию дефолтного значения для объекта, все свойства которого опциональны.

    Значение имеет тип `nested`.

    | +| `url` |

    **string**

    Значение должно быть валидным URL.

    Разрешенные схемы: `https`.

    Значение по умолчанию: `https://yandex.ru`.

    | + +### nested +| Параметры | Описание | +| --- | --- | +| `non_optional` |

    **string**

    Обязательный параметр.

    | +| `int` |

    **int**

    Ограничение для значения `x`: `x >= 0`.

    Значение по умолчанию: `0`.

    | +| `url` |

    **string**

    Значение должно быть валидным URL.

    Разрешенные схемы: `https`.

    Значение по умолчанию: `https://yandex.ru`.

    | + +
    +JSON + ```json { type*: "entity_with_property_with_default_value", @@ -14,18 +31,4 @@ url: "string" } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `int` |

    **int**

    Ограничение для значения `x`: `x >= 0`.

    Значение по умолчанию: `0`.

    | -| `nested` |

    **object**

    non_optional используется, чтобы запретить автогенерацию дефолтного значения для объекта, все свойства которого опциональны.

    Значение имеет тип `nested`.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_property_with_default_value`.

    | -| `url` |

    **string**

    Значение должно быть валидным URL.

    Разрешенные схемы: `https`.

    Значение по умолчанию: `https://yandex.ru`.

    | - -### nested -| Параметры | Описание | -| --- | --- | -| `int` |

    **int**

    Ограничение для значения `x`: `x >= 0`.

    Значение по умолчанию: `0`.

    | -| `non_optional` |

    **string**

    Обязательный параметр.

    | -| `url` |

    **string**

    Значение должно быть валидным URL.

    Разрешенные схемы: `https`.

    Значение по умолчанию: `https://yandex.ru`.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_raw_array.md b/api_generator/tests/references/documentation/ru/entity_with_raw_array.md index 3fe571432..5ea6d19f3 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_raw_array.md +++ b/api_generator/tests/references/documentation/ru/entity_with_raw_array.md @@ -1,16 +1,19 @@ # entity_with_raw_array Описания пока нет. -## JSON -```json -{ - type*: "entity_with_raw_array", - array*: "raw_array" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `array` |

    **raw_array**

    Обязательный параметр.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_raw_array`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_raw_array", + array*: "raw_array" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_required_property.md b/api_generator/tests/references/documentation/ru/entity_with_required_property.md index 4ab24097a..ba2022208 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_required_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_required_property.md @@ -1,16 +1,19 @@ # entity_with_required_property Описания пока нет. -## JSON -```json -{ - type*: "entity_with_required_property", - property*: "string" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `property` |

    **string**

    Обязательный параметр.

    Строка должна быть непустой.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_required_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_required_property", + property*: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_simple_properties.md b/api_generator/tests/references/documentation/ru/entity_with_simple_properties.md index 377bca017..4f9b3675e 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_simple_properties.md +++ b/api_generator/tests/references/documentation/ru/entity_with_simple_properties.md @@ -1,7 +1,23 @@ # entity_with_simple_properties Объект с простыми свойствами. -## JSON +## Параметры +| Параметры | Описание | +| --- | --- | +| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_simple_properties`.

    | +| `boolean` |

    **bool**

    Логическое значение.

    | +| `boolean_int` |

    **bool_int**

    Параметр устарел.

    Логическое значение в числовом формате.

    Доступные платформы: Android.

    | +| `color` |

    **string**

    Цвет.

    Допустимые форматы: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.

    | +| `double` |

    **number**

    Число с плавающей точкой.

    | +| `id` |

    **int**

    Идентификатор. Не может содержать выражение.

    Значение по умолчанию: `0`.

    | +| `integer` |

    **int**

    Целое число.

    Значение по умолчанию: `0`.

    | +| `positive_integer` |

    **int**

    Положительное целое число.

    Ограничение для значения `x`: `x > 0`.

    Функциональность находится в разработке.

    | +| `string` |

    **string**

    Строка.

    Доступные платформы: Android, iOS, веб.

    | +| `url` |

    **string**

    Значение должно быть валидным URL.

    | + +
    +JSON + ```json { type*: "entity_with_simple_properties", @@ -16,17 +32,4 @@ url: "string" } ``` - -## Параметры -| Параметры | Описание | -| --- | --- | -| `boolean` |

    **bool**

    Логическое значение.

    | -| `boolean_int` |

    **bool_int**

    Параметр устарел.

    Логическое значение в числовом формате.

    Доступные платформы: Android.

    | -| `color` |

    **string**

    Цвет.

    Допустимые форматы: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.

    | -| `double` |

    **number**

    Число с плавающей точкой.

    | -| `id` |

    **int**

    Идентификатор. Не может содержать выражение.

    Значение по умолчанию: `0`.

    | -| `integer` |

    **int**

    Целое число.

    Значение по умолчанию: `0`.

    | -| `positive_integer` |

    **int**

    Положительное целое число.

    Ограничение для значения `x`: `x > 0`.

    Функциональность находится в разработке.

    | -| `string` |

    **string**

    Строка.

    Доступные платформы: Android, iOS, веб.

    | -| `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_simple_properties`.

    | -| `url` |

    **string**

    Значение должно быть валидным URL.

    | +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_string_array_property.md b/api_generator/tests/references/documentation/ru/entity_with_string_array_property.md index 30851f4cf..ccc810005 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_string_array_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_string_array_property.md @@ -1,16 +1,19 @@ # entity_with_string_array_property Описания пока нет. -## JSON -```json -{ - type*: "entity_with_string_array_property", - array*: [ "string", ... ] -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `array` |

    **array**

    Обязательный параметр.

    Массив должен быть непустым.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_string_array_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_array_property", + array*: [ "string", ... ] +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_string_enum_property.md b/api_generator/tests/references/documentation/ru/entity_with_string_enum_property.md index db1015429..5f908faf9 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_string_enum_property.md +++ b/api_generator/tests/references/documentation/ru/entity_with_string_enum_property.md @@ -1,16 +1,19 @@ # entity_with_string_enum_property Описания пока нет. -## JSON -```json -{ - type*: "entity_with_string_enum_property", - property*: "string" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `property` |

    **string**

    Обязательный параметр.

    Возможные значения: `first`, `second`.

    | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_string_enum_property`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_enum_property", + property*: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_with_string_enum_property_with_default_value.md b/api_generator/tests/references/documentation/ru/entity_with_string_enum_property_with_default_value.md index d5e8bed88..a3129b7dd 100644 --- a/api_generator/tests/references/documentation/ru/entity_with_string_enum_property_with_default_value.md +++ b/api_generator/tests/references/documentation/ru/entity_with_string_enum_property_with_default_value.md @@ -1,16 +1,19 @@ # entity_with_string_enum_property_with_default_value Описания пока нет. -## JSON -```json -{ - type*: "entity_with_string_enum_property_with_default_value", - value: "string" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_with_string_enum_property_with_default_value`.

    | | `value` |

    **string**

    Возможные значения: `first`, `second`, `third`.

    Значение по умолчанию: `second`.

    | + +
    +JSON + +```json +{ + type*: "entity_with_string_enum_property_with_default_value", + value: "string" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/entity_without_properties.md b/api_generator/tests/references/documentation/ru/entity_without_properties.md index 0a8fe638a..df9562b32 100644 --- a/api_generator/tests/references/documentation/ru/entity_without_properties.md +++ b/api_generator/tests/references/documentation/ru/entity_without_properties.md @@ -1,14 +1,17 @@ # entity_without_properties Описания пока нет. -## JSON -```json -{ - type*: "entity_without_properties" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `entity_without_properties`.

    | + +
    +JSON + +```json +{ + type*: "entity_without_properties" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/with_default.md b/api_generator/tests/references/documentation/ru/with_default.md index 4ec21940a..2d156867f 100644 --- a/api_generator/tests/references/documentation/ru/with_default.md +++ b/api_generator/tests/references/documentation/ru/with_default.md @@ -1,14 +1,17 @@ # with_default Описания пока нет. -## JSON -```json -{ - type: "default" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `type` |

    **string**

    Значение всегда должно равняться `default`.

    | + +
    +JSON + +```json +{ + type: "default" +} +``` +
    diff --git a/api_generator/tests/references/documentation/ru/without_default.md b/api_generator/tests/references/documentation/ru/without_default.md index 77f753826..5e7dd757e 100644 --- a/api_generator/tests/references/documentation/ru/without_default.md +++ b/api_generator/tests/references/documentation/ru/without_default.md @@ -1,14 +1,17 @@ # without_default Описания пока нет. -## JSON -```json -{ - type*: "non_default" -} -``` - ## Параметры | Параметры | Описание | | --- | --- | | `type` |

    **string**

    Обязательный параметр.

    Значение всегда должно равняться `non_default`.

    | + +
    +JSON + +```json +{ + type*: "non_default" +} +``` +
    diff --git a/api_generator/tests/references/documentation/toc.yaml b/api_generator/tests/references/documentation/toc.yaml index 324ea736a..9ca4356b0 100644 --- a/api_generator/tests/references/documentation/toc.yaml +++ b/api_generator/tests/references/documentation/toc.yaml @@ -1,75 +1,75 @@ title: href: items: - -name: entity - href: concepts/divs/entity.md - hidden: true - -name: entity_with_array - href: concepts/divs/entity_with_array.md - hidden: true - -name: entity_with_array_of_enums - href: concepts/divs/entity_with_array_of_enums.md - hidden: true - -name: entity_with_array_of_expressions - href: concepts/divs/entity_with_array_of_expressions.md - hidden: true - -name: entity_with_array_of_nested_items - href: concepts/divs/entity_with_array_of_nested_items.md - hidden: true - -name: entity_with_array_with_transform - href: concepts/divs/entity_with_array_with_transform.md - hidden: true - -name: entity_with_complex_property - href: concepts/divs/entity_with_complex_property.md - hidden: true - -name: entity_with_complex_property_with_default_value - href: concepts/divs/entity_with_complex_property_with_default_value.md - hidden: true - -name: entity_with_entity_property - href: concepts/divs/entity_with_entity_property.md - hidden: true - -name: entity_with_json_property - href: concepts/divs/entity_with_json_property.md - hidden: true - -name: entity_with_optional_complex_property - href: concepts/divs/entity_with_optional_complex_property.md - hidden: true - -name: entity_with_optional_property - href: concepts/divs/entity_with_optional_property.md - hidden: true - -name: entity_with_optional_string_enum_property - href: concepts/divs/entity_with_optional_string_enum_property.md - hidden: true - -name: entity_with_property_with_default_value - href: concepts/divs/entity_with_property_with_default_value.md - hidden: true - -name: entity_with_raw_array - href: concepts/divs/entity_with_raw_array.md - hidden: true - -name: entity_with_required_property - href: concepts/divs/entity_with_required_property.md - hidden: true - -name: entity_with_simple_properties - href: concepts/divs/entity_with_simple_properties.md - hidden: true - -name: entity_with_string_array_property - href: concepts/divs/entity_with_string_array_property.md - hidden: true - -name: entity_with_string_enum_property - href: concepts/divs/entity_with_string_enum_property.md - hidden: true - -name: entity_with_string_enum_property_with_default_value - href: concepts/divs/entity_with_string_enum_property_with_default_value.md - hidden: true - -name: entity_without_properties - href: concepts/divs/entity_without_properties.md - hidden: true - -name: enum_with_default_type - href: concepts/divs/enum_with_default_type.md - hidden: true - -name: with_default - href: concepts/divs/with_default.md - hidden: true - -name: without_default - href: concepts/divs/without_default.md - hidden: true \ No newline at end of file + - name: entity + href: concepts/divs/2/entity.md + hidden: true + - name: entity_with_array + href: concepts/divs/2/entity_with_array.md + hidden: true + - name: entity_with_array_of_enums + href: concepts/divs/2/entity_with_array_of_enums.md + hidden: true + - name: entity_with_array_of_expressions + href: concepts/divs/2/entity_with_array_of_expressions.md + hidden: true + - name: entity_with_array_of_nested_items + href: concepts/divs/2/entity_with_array_of_nested_items.md + hidden: true + - name: entity_with_array_with_transform + href: concepts/divs/2/entity_with_array_with_transform.md + hidden: true + - name: entity_with_complex_property + href: concepts/divs/2/entity_with_complex_property.md + hidden: true + - name: entity_with_complex_property_with_default_value + href: concepts/divs/2/entity_with_complex_property_with_default_value.md + hidden: true + - name: entity_with_entity_property + href: concepts/divs/2/entity_with_entity_property.md + hidden: true + - name: entity_with_json_property + href: concepts/divs/2/entity_with_json_property.md + hidden: true + - name: entity_with_optional_complex_property + href: concepts/divs/2/entity_with_optional_complex_property.md + hidden: true + - name: entity_with_optional_property + href: concepts/divs/2/entity_with_optional_property.md + hidden: true + - name: entity_with_optional_string_enum_property + href: concepts/divs/2/entity_with_optional_string_enum_property.md + hidden: true + - name: entity_with_property_with_default_value + href: concepts/divs/2/entity_with_property_with_default_value.md + hidden: true + - name: entity_with_raw_array + href: concepts/divs/2/entity_with_raw_array.md + hidden: true + - name: entity_with_required_property + href: concepts/divs/2/entity_with_required_property.md + hidden: true + - name: entity_with_simple_properties + href: concepts/divs/2/entity_with_simple_properties.md + hidden: true + - name: entity_with_string_array_property + href: concepts/divs/2/entity_with_string_array_property.md + hidden: true + - name: entity_with_string_enum_property + href: concepts/divs/2/entity_with_string_enum_property.md + hidden: true + - name: entity_with_string_enum_property_with_default_value + href: concepts/divs/2/entity_with_string_enum_property_with_default_value.md + hidden: true + - name: entity_without_properties + href: concepts/divs/2/entity_without_properties.md + hidden: true + - name: enum_with_default_type + href: concepts/divs/2/enum_with_default_type.md + hidden: true + - name: with_default + href: concepts/divs/2/with_default.md + hidden: true + - name: without_default + href: concepts/divs/2/without_default.md + hidden: true \ No newline at end of file