GitHub/divkit
1
0
Fork 0
mirror of https://github.com/divkit/divkit.git synced 2026-06-06 20:07:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation update to release flow

Browse Source 
6f6901f1f0bf2098ff8439b0cc48c524016219ba
This commit is contained in:
vyaivanove
2024-02-28 17:28:18 +03:00
parent ef60feba4e
commit 679bf222a7
47 changed files with 627 additions and 481 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api_generator/api_generator/generators/documentation/generator.py
+19 -9
View File
@@ -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),
'',
'<details>',
'<summary>JSON</summary>',
'',
'```json',
str(entity.json_description(obj_stack=[])),
'```',
'',
f'## {params_header}',
self.__fields_table(entity)
'</details>',
])
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
])
api_generator/api_generator/generators/documentation/translations.py
+4
View File
@@ -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": "Можно создать при помощи метода [{}]."
api_generator/tests/references/documentation/en/entity_with_array.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_array
No description yet.
## JSON
```json
{
type*: "entity_with_array",
array*: [ entity, ... ]
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `array` | <p>**array**</p><p>Required parameter.</p><p>An array must not be empty.</p><p>List of possible values:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_array`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array",
array*: [ entity, ... ]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_array_of_enums.md
+11 -8
View File
@@ -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` | <p>**array**</p><p>Required parameter.</p><p>An array must not be empty.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_array_of_enums`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_enums",
items*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_array_of_expressions.md
+11 -8
View File
@@ -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` | <p>**array**</p><p>Required parameter.</p><p>An array must not be empty.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_array_of_expressions`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_expressions",
items*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_array_of_nested_items.md
+17 -14
View File
@@ -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` | <p>**object**</p><p>Required parameter.</p><p>The value has the type `entity`.</p><p>List of possible values:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `property` | <p>**string**</p><p>Required parameter.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_nested_items",
items*: [
{
entity*: entity,
property*: "string"
},
...
]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_array_with_transform.md
+11 -8
View File
@@ -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` | <p>**array**</p><p>Required parameter.</p><p>An array must not be empty.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_array_with_transform`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_with_transform",
array*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_complex_property.md
+13 -10
View File
@@ -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` | <p>**string**</p><p>Required parameter.</p><p>The value must be a valid URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_complex_property",
property*: {
value*: "string"
}
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_complex_property_with_default_value.md
+15 -12
View File
@@ -1,7 +1,20 @@
# entity_with_complex_property_with_default_value
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_complex_property_with_default_value`.</p> |
| `property` | <p>**object**</p><p>The value has the type `property`.</p><p>Default value: `{ "value": "Default text" }`.</p> |
### property
| Parameters | Description |
| --- | --- |
| `value` | <p>**string**</p><p>Required parameter.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_complex_property_with_default_value",
@@ -10,14 +23,4 @@ No description yet.
}
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `property` | <p>**object**</p><p>The value has the type `property`.</p><p>Default value: `{ "value": "Default text" }`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_complex_property_with_default_value`.</p> |
### property
| Parameters | Description |
| --- | --- |
| `value` | <p>**string**</p><p>Required parameter.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_entity_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_entity_property
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_entity_property`.</p> |
| `entity` | <p>**object**</p><p>The value has the type `entity`.</p><p>Default value: `{ "type": "entity_with_string_enum_property", "property": "second" }`.</p><p>List of possible values:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_entity_property",
entity: entity
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `entity` | <p>**object**</p><p>The value has the type `entity`.</p><p>Default value: `{ "type": "entity_with_string_enum_property", "property": "second" }`.</p><p>List of possible values:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_entity_property`.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_json_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_json_property
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_json_property`.</p> |
| `json_property` | <p>**object**</p><p>Default value: `{</p><p> "key": "value",</p><p> "items": [</p><p> "value"</p><p> ]</p><p>}`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_json_property",
json_property: "object"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `json_property` | <p>**object**</p><p>Default value: `{</p><p> "key": "value",</p><p> "items": [</p><p> "value"</p><p> ]</p><p>}`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_json_property`.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_optional_complex_property.md
+15 -12
View File
@@ -1,7 +1,20 @@
# entity_with_optional_complex_property
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_complex_property`.</p> |
| `property` | <p>**object**</p><p>The value has the type `property`.</p> |
### property
| Parameters | Description |
| --- | --- |
| `value` | <p>**string**</p><p>Required parameter.</p><p>The value must be a valid URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_complex_property",
@@ -10,14 +23,4 @@ No description yet.
}
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `property` | <p>**object**</p><p>The value has the type `property`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_complex_property`.</p> |
### property
| Parameters | Description |
| --- | --- |
| `value` | <p>**string**</p><p>Required parameter.</p><p>The value must be a valid URL.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_optional_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_optional_property
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_property`.</p> |
| `property` | <p>**string**</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_property",
property: "string"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `property` | <p>**string**</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_property`.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_optional_string_enum_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_optional_string_enum_property
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_string_enum_property`.</p> |
| `property` | <p>**string**</p><p>Possible values: `first`, `second`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_string_enum_property",
property: "string"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `property` | <p>**string**</p><p>Possible values: `first`, `second`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_optional_string_enum_property`.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_property_with_default_value.md
+19 -16
View File
@@ -1,7 +1,24 @@
# entity_with_property_with_default_value
No description yet.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_property_with_default_value`.</p> |
| `int` | <p>**int**</p><p>Restriction for the value `x`: `x >= 0`.</p><p>Default value: `0`.</p> |
| `nested` | <p>**object**</p><p>non_optional is used to suppress auto-generation of default value for object with all-optional fields.</p><p>The value has the type `nested`.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p><p>Allowed schemes: `https`.</p><p>Default value: `https://yandex.ru`.</p> |
### nested
| Parameters | Description |
| --- | --- |
| `non_optional` | <p>**string**</p><p>Required parameter.</p> |
| `int` | <p>**int**</p><p>Restriction for the value `x`: `x >= 0`.</p><p>Default value: `0`.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p><p>Allowed schemes: `https`.</p><p>Default value: `https://yandex.ru`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_property_with_default_value",
@@ -14,18 +31,4 @@ No description yet.
url: "string"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `int` | <p>**int**</p><p>Restriction for the value `x`: `x >= 0`.</p><p>Default value: `0`.</p> |
| `nested` | <p>**object**</p><p>non_optional is used to suppress auto-generation of default value for object with all-optional fields.</p><p>The value has the type `nested`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_property_with_default_value`.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p><p>Allowed schemes: `https`.</p><p>Default value: `https://yandex.ru`.</p> |
### nested
| Parameters | Description |
| --- | --- |
| `int` | <p>**int**</p><p>Restriction for the value `x`: `x >= 0`.</p><p>Default value: `0`.</p> |
| `non_optional` | <p>**string**</p><p>Required parameter.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p><p>Allowed schemes: `https`.</p><p>Default value: `https://yandex.ru`.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_raw_array.md
+11 -8
View File
@@ -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` | <p>**raw_array**</p><p>Required parameter.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_raw_array`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_raw_array",
array*: "raw_array"
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_required_property.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_required_property
No description yet.
## JSON
```json
{
type*: "entity_with_required_property",
property*: "string"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `property` | <p>**string**</p><p>Required parameter.</p><p>A string must not be empty.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_required_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_required_property",
property*: "string"
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_simple_properties.md
+18 -15
View File
@@ -1,7 +1,23 @@
# entity_with_simple_properties
Entity with simple properties.
## JSON
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_simple_properties`.</p> |
| `boolean` | <p>**bool**</p><p>Boolean property.</p> |
| `boolean_int` | <p>**bool_int**</p><p>Parameter is deprecated.</p><p>Boolean value in numeric format.</p><p>Available platforms: Android.</p> |
| `color` | <p>**string**</p><p>Color.</p><p>Valid formats: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.</p> |
| `double` | <p>**number**</p><p>Floating point number.</p> |
| `id` | <p>**int**</p><p>ID. Can't contain expressions.</p><p>Default value: `0`.</p> |
| `integer` | <p>**int**</p><p>Integer.</p><p>Default value: `0`.</p> |
| `positive_integer` | <p>**int**</p><p>Positive integer.</p><p>Restriction for the value `x`: `x > 0`.</p><p>Functionality is under development.</p> |
| `string` | <p>**string**</p><p>String.</p><p>Available platforms: Android, iOS, web.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_simple_properties",
@@ -16,17 +32,4 @@ Entity with simple properties.
url: "string"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `boolean` | <p>**bool**</p><p>Boolean property.</p> |
| `boolean_int` | <p>**bool_int**</p><p>Parameter is deprecated.</p><p>Boolean value in numeric format.</p><p>Available platforms: Android.</p> |
| `color` | <p>**string**</p><p>Color.</p><p>Valid formats: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.</p> |
| `double` | <p>**number**</p><p>Floating point number.</p> |
| `id` | <p>**int**</p><p>ID. Can't contain expressions.</p><p>Default value: `0`.</p> |
| `integer` | <p>**int**</p><p>Integer.</p><p>Default value: `0`.</p> |
| `positive_integer` | <p>**int**</p><p>Positive integer.</p><p>Restriction for the value `x`: `x > 0`.</p><p>Functionality is under development.</p> |
| `string` | <p>**string**</p><p>String.</p><p>Available platforms: Android, iOS, web.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_simple_properties`.</p> |
| `url` | <p>**string**</p><p>The value must be a valid URL.</p> |
</details>
api_generator/tests/references/documentation/en/entity_with_string_array_property.md
+11 -8
View File
@@ -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` | <p>**array**</p><p>Required parameter.</p><p>An array must not be empty.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_string_array_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_array_property",
array*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_string_enum_property.md
+11 -8
View File
@@ -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` | <p>**string**</p><p>Required parameter.</p><p>Possible values: `first`, `second`.</p> |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_string_enum_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_enum_property",
property*: "string"
}
```
</details>
api_generator/tests/references/documentation/en/entity_with_string_enum_property_with_default_value.md
+11 -8
View File
@@ -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` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_with_string_enum_property_with_default_value`.</p> |
| `value` | <p>**string**</p><p>Possible values: `first`, `second`, `third`.</p><p>Default value: `second`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_enum_property_with_default_value",
value: "string"
}
```
</details>
api_generator/tests/references/documentation/en/entity_without_properties.md
+10 -7
View File
@@ -1,14 +1,17 @@
# entity_without_properties
No description yet.
## JSON
```json
{
type*: "entity_without_properties"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `entity_without_properties`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_without_properties"
}
```
</details>
api_generator/tests/references/documentation/en/with_default.md
+10 -7
View File
@@ -1,14 +1,17 @@
# with_default
No description yet.
## JSON
```json
{
type: "default"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>The value must always be `default`.</p> |
<details>
<summary>JSON</summary>
```json
{
type: "default"
}
```
</details>
api_generator/tests/references/documentation/en/without_default.md
+10 -7
View File
@@ -1,14 +1,17 @@
# without_default
No description yet.
## JSON
```json
{
type*: "non_default"
}
```
## Parameters
| Parameters | Description |
| --- | --- |
| `type` | <p>**string**</p><p>Required parameter.</p><p>The value must always be `non_default`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "non_default"
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_array.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_array
Описания пока нет.
## JSON
```json
{
type*: "entity_with_array",
array*: [ entity, ... ]
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `array` | <p>**array**</p><p>Обязательный параметр.</p><p>Массив должен быть непустым.</p><p>Список возможных значений:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_array`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array",
array*: [ entity, ... ]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_array_of_enums.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_array_of_enums
Описания пока нет.
## JSON
```json
{
type*: "entity_with_array_of_enums",
items*: [ "string", ... ]
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `items` | <p>**array**</p><p>Обязательный параметр.</p><p>Массив должен быть непустым.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_array_of_enums`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_enums",
items*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_array_of_expressions.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_array_of_expressions
Описания пока нет.
## JSON
```json
{
type*: "entity_with_array_of_expressions",
items*: [ "string", ... ]
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `items` | <p>**array**</p><p>Обязательный параметр.</p><p>Массив должен быть непустым.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_array_of_expressions`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_expressions",
items*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_array_of_nested_items.md
+17 -14
View File
@@ -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` | <p>**object**</p><p>Обязательный параметр.</p><p>Значение имеет тип `entity`.</p><p>Список возможных значений:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `property` | <p>**string**</p><p>Обязательный параметр.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_of_nested_items",
items*: [
{
entity*: entity,
property*: "string"
},
...
]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_array_with_transform.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_array_with_transform
Описания пока нет.
## JSON
```json
{
type*: "entity_with_array_with_transform",
array*: [ "string", ... ]
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `array` | <p>**array**</p><p>Обязательный параметр.</p><p>Массив должен быть непустым.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_array_with_transform`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_array_with_transform",
array*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_complex_property.md
+13 -10
View File
@@ -1,16 +1,6 @@
# entity_with_complex_property
Описания пока нет.
## JSON
```json
{
type*: "entity_with_complex_property",
property*: {
value*: "string"
}
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
@@ -21,3 +11,16 @@
| Параметры | Описание |
| --- | --- |
| `value` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение должно быть валидным URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_complex_property",
property*: {
value*: "string"
}
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_complex_property_with_default_value.md
+15 -12
View File
@@ -1,7 +1,20 @@
# entity_with_complex_property_with_default_value
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_complex_property_with_default_value`.</p> |
| `property` | <p>**object**</p><p>Значение имеет тип `property`.</p><p>Значение по умолчанию: `{ "value": "Default text" }`.</p> |
### property
| Параметры | Описание |
| --- | --- |
| `value` | <p>**string**</p><p>Обязательный параметр.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_complex_property_with_default_value",
@@ -10,14 +23,4 @@
}
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**object**</p><p>Значение имеет тип `property`.</p><p>Значение по умолчанию: `{ "value": "Default text" }`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_complex_property_with_default_value`.</p> |
### property
| Параметры | Описание |
| --- | --- |
| `value` | <p>**string**</p><p>Обязательный параметр.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_entity_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_entity_property
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_entity_property`.</p> |
| `entity` | <p>**object**</p><p>Значение имеет тип `entity`.</p><p>Значение по умолчанию: `{ "type": "entity_with_string_enum_property", "property": "second" }`.</p><p>Список возможных значений:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_entity_property",
entity: entity
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `entity` | <p>**object**</p><p>Значение имеет тип `entity`.</p><p>Значение по умолчанию: `{ "type": "entity_with_string_enum_property", "property": "second" }`.</p><p>Список возможных значений:<li>[entity_with_array](entity_with_array.md#entity_with_array)</li><li>[entity_with_array_of_enums](entity_with_array_of_enums.md#entity_with_array_of_enums)</li><li>[entity_with_array_of_expressions](entity_with_array_of_expressions.md#entity_with_array_of_expressions)</li><li>[entity_with_array_of_nested_items](entity_with_array_of_nested_items.md#entity_with_array_of_nested_items)</li><li>[entity_with_array_with_transform](entity_with_array_with_transform.md#entity_with_array_with_transform)</li><li>[entity_with_complex_property](entity_with_complex_property.md#entity_with_complex_property)</li><li>[entity_with_complex_property_with_default_value](entity_with_complex_property_with_default_value.md#entity_with_complex_property_with_default_value)</li><li>[entity_with_entity_property](entity_with_entity_property.md#entity_with_entity_property)</li><li>[entity_with_optional_complex_property](entity_with_optional_complex_property.md#entity_with_optional_complex_property)</li><li>[entity_with_optional_property](entity_with_optional_property.md#entity_with_optional_property)</li><li>[entity_with_optional_string_enum_property](entity_with_optional_string_enum_property.md#entity_with_optional_string_enum_property)</li><li>[entity_with_property_with_default_value](entity_with_property_with_default_value.md#entity_with_property_with_default_value)</li><li>[entity_with_raw_array](entity_with_raw_array.md#entity_with_raw_array)</li><li>[entity_with_required_property](entity_with_required_property.md#entity_with_required_property)</li><li>[entity_with_simple_properties](entity_with_simple_properties.md#entity_with_simple_properties)</li><li>[entity_with_string_array_property](entity_with_string_array_property.md#entity_with_string_array_property)</li><li>[entity_with_string_enum_property](entity_with_string_enum_property.md#entity_with_string_enum_property)</li><li>[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)</li><li>[entity_without_properties](entity_without_properties.md#entity_without_properties)</li></p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_entity_property`.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_json_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_json_property
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_json_property`.</p> |
| `json_property` | <p>**object**</p><p>Значение по умолчанию: `{</p><p> "key": "value",</p><p> "items": [</p><p> "value"</p><p> ]</p><p>}`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_json_property",
json_property: "object"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `json_property` | <p>**object**</p><p>Значение по умолчанию: `{</p><p> "key": "value",</p><p> "items": [</p><p> "value"</p><p> ]</p><p>}`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_json_property`.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_optional_complex_property.md
+15 -12
View File
@@ -1,7 +1,20 @@
# entity_with_optional_complex_property
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_complex_property`.</p> |
| `property` | <p>**object**</p><p>Значение имеет тип `property`.</p> |
### property
| Параметры | Описание |
| --- | --- |
| `value` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение должно быть валидным URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_complex_property",
@@ -10,14 +23,4 @@
}
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**object**</p><p>Значение имеет тип `property`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_complex_property`.</p> |
### property
| Параметры | Описание |
| --- | --- |
| `value` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение должно быть валидным URL.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_optional_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_optional_property
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_property`.</p> |
| `property` | <p>**string**</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_property",
property: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**string**</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_property`.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_optional_string_enum_property.md
+10 -7
View File
@@ -1,16 +1,19 @@
# entity_with_optional_string_enum_property
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_string_enum_property`.</p> |
| `property` | <p>**string**</p><p>Возможные значения: `first`, `second`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_optional_string_enum_property",
property: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**string**</p><p>Возможные значения: `first`, `second`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_optional_string_enum_property`.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_property_with_default_value.md
+19 -16
View File
@@ -1,7 +1,24 @@
# entity_with_property_with_default_value
Описания пока нет.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_property_with_default_value`.</p> |
| `int` | <p>**int**</p><p>Ограничение для значения `x`: `x >= 0`.</p><p>Значение по умолчанию: `0`.</p> |
| `nested` | <p>**object**</p><p>non_optional используется, чтобы запретить автогенерацию дефолтного значения для объекта, все свойства которого опциональны.</p><p>Значение имеет тип `nested`.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p><p>Разрешенные схемы: `https`.</p><p>Значение по умолчанию: `https://yandex.ru`.</p> |
### nested
| Параметры | Описание |
| --- | --- |
| `non_optional` | <p>**string**</p><p>Обязательный параметр.</p> |
| `int` | <p>**int**</p><p>Ограничение для значения `x`: `x >= 0`.</p><p>Значение по умолчанию: `0`.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p><p>Разрешенные схемы: `https`.</p><p>Значение по умолчанию: `https://yandex.ru`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_property_with_default_value",
@@ -14,18 +31,4 @@
url: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `int` | <p>**int**</p><p>Ограничение для значения `x`: `x >= 0`.</p><p>Значение по умолчанию: `0`.</p> |
| `nested` | <p>**object**</p><p>non_optional используется, чтобы запретить автогенерацию дефолтного значения для объекта, все свойства которого опциональны.</p><p>Значение имеет тип `nested`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_property_with_default_value`.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p><p>Разрешенные схемы: `https`.</p><p>Значение по умолчанию: `https://yandex.ru`.</p> |
### nested
| Параметры | Описание |
| --- | --- |
| `int` | <p>**int**</p><p>Ограничение для значения `x`: `x >= 0`.</p><p>Значение по умолчанию: `0`.</p> |
| `non_optional` | <p>**string**</p><p>Обязательный параметр.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p><p>Разрешенные схемы: `https`.</p><p>Значение по умолчанию: `https://yandex.ru`.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_raw_array.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_raw_array
Описания пока нет.
## JSON
```json
{
type*: "entity_with_raw_array",
array*: "raw_array"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `array` | <p>**raw_array**</p><p>Обязательный параметр.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_raw_array`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_raw_array",
array*: "raw_array"
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_required_property.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_required_property
Описания пока нет.
## JSON
```json
{
type*: "entity_with_required_property",
property*: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**string**</p><p>Обязательный параметр.</p><p>Строка должна быть непустой.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_required_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_required_property",
property*: "string"
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_simple_properties.md
+18 -15
View File
@@ -1,7 +1,23 @@
# entity_with_simple_properties
Объект с простыми свойствами.
## JSON
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_simple_properties`.</p> |
| `boolean` | <p>**bool**</p><p>Логическое значение.</p> |
| `boolean_int` | <p>**bool_int**</p><p>Параметр устарел.</p><p>Логическое значение в числовом формате.</p><p>Доступные платформы: Android.</p> |
| `color` | <p>**string**</p><p>Цвет.</p><p>Допустимые форматы: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.</p> |
| `double` | <p>**number**</p><p>Число с плавающей точкой.</p> |
| `id` | <p>**int**</p><p>Идентификатор. Не может содержать выражение.</p><p>Значение по умолчанию: `0`.</p> |
| `integer` | <p>**int**</p><p>Целое число.</p><p>Значение по умолчанию: `0`.</p> |
| `positive_integer` | <p>**int**</p><p>Положительное целое число.</p><p>Ограничение для значения `x`: `x > 0`.</p><p>Функциональность находится в разработке.</p> |
| `string` | <p>**string**</p><p>Строка.</p><p>Доступные платформы: Android, iOS, веб.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_simple_properties",
@@ -16,17 +32,4 @@
url: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `boolean` | <p>**bool**</p><p>Логическое значение.</p> |
| `boolean_int` | <p>**bool_int**</p><p>Параметр устарел.</p><p>Логическое значение в числовом формате.</p><p>Доступные платформы: Android.</p> |
| `color` | <p>**string**</p><p>Цвет.</p><p>Допустимые форматы: `#RGB`, `#ARGB`, `#RRGGBB`, `#AARRGGBB`.</p> |
| `double` | <p>**number**</p><p>Число с плавающей точкой.</p> |
| `id` | <p>**int**</p><p>Идентификатор. Не может содержать выражение.</p><p>Значение по умолчанию: `0`.</p> |
| `integer` | <p>**int**</p><p>Целое число.</p><p>Значение по умолчанию: `0`.</p> |
| `positive_integer` | <p>**int**</p><p>Положительное целое число.</p><p>Ограничение для значения `x`: `x > 0`.</p><p>Функциональность находится в разработке.</p> |
| `string` | <p>**string**</p><p>Строка.</p><p>Доступные платформы: Android, iOS, веб.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_simple_properties`.</p> |
| `url` | <p>**string**</p><p>Значение должно быть валидным URL.</p> |
</details>
api_generator/tests/references/documentation/ru/entity_with_string_array_property.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_string_array_property
Описания пока нет.
## JSON
```json
{
type*: "entity_with_string_array_property",
array*: [ "string", ... ]
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `array` | <p>**array**</p><p>Обязательный параметр.</p><p>Массив должен быть непустым.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_string_array_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_array_property",
array*: [ "string", ... ]
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_string_enum_property.md
+11 -8
View File
@@ -1,16 +1,19 @@
# entity_with_string_enum_property
Описания пока нет.
## JSON
```json
{
type*: "entity_with_string_enum_property",
property*: "string"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `property` | <p>**string**</p><p>Обязательный параметр.</p><p>Возможные значения: `first`, `second`.</p> |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_string_enum_property`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_enum_property",
property*: "string"
}
```
</details>
api_generator/tests/references/documentation/ru/entity_with_string_enum_property_with_default_value.md
+11 -8
View File
@@ -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` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_with_string_enum_property_with_default_value`.</p> |
| `value` | <p>**string**</p><p>Возможные значения: `first`, `second`, `third`.</p><p>Значение по умолчанию: `second`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_with_string_enum_property_with_default_value",
value: "string"
}
```
</details>
api_generator/tests/references/documentation/ru/entity_without_properties.md
+10 -7
View File
@@ -1,14 +1,17 @@
# entity_without_properties
Описания пока нет.
## JSON
```json
{
type*: "entity_without_properties"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `entity_without_properties`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "entity_without_properties"
}
```
</details>
api_generator/tests/references/documentation/ru/with_default.md
+10 -7
View File
@@ -1,14 +1,17 @@
# with_default
Описания пока нет.
## JSON
```json
{
type: "default"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Значение всегда должно равняться `default`.</p> |
<details>
<summary>JSON</summary>
```json
{
type: "default"
}
```
</details>
api_generator/tests/references/documentation/ru/without_default.md
+10 -7
View File
@@ -1,14 +1,17 @@
# without_default
Описания пока нет.
## JSON
```json
{
type*: "non_default"
}
```
## Параметры
| Параметры | Описание |
| --- | --- |
| `type` | <p>**string**</p><p>Обязательный параметр.</p><p>Значение всегда должно равняться `non_default`.</p> |
<details>
<summary>JSON</summary>
```json
{
type*: "non_default"
}
```
</details>
api_generator/tests/references/documentation/toc.yaml
+72 -72
View File
@@ -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
- 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