Программный интерфейс
/web_api/autotest_step/reorder
/web_api/autotest_step/reorder
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_elements/autotest_step/reorder.request.json
POST /web_api/autotest_step/reorder body
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
autotest_case_id | integer | Да | minimum 1 |
autotest_step_ids | array of integer | Да | - |
Другие поля верхнего уровня запрещены.
Ответ
main-app://schemas/api_elements/autotest_step/reorder.response.json
POST autotest_step/reorder success
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
api_code | integer | Да | const 200 |
api_result | any | Да | - |
empty | boolean | Нет | - |
Другие поля верхнего уровня запрещены.
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_elements/autotest_step/reorder.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/autotest_step/reorder.request.json",
"title": "POST /web_api/autotest_step/reorder body",
"type": "object",
"required": [
"autotest_case_id",
"autotest_step_ids"
],
"additionalProperties": false,
"properties": {
"autotest_case_id": {
"type": "integer",
"minimum": 1
},
"autotest_step_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}Ответ: main-app://schemas/api_elements/autotest_step/reorder.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/autotest_step/reorder.response.json",
"title": "POST autotest_step/reorder success",
"allOf": [
{
"$ref": "main-app://schemas/_shared/envelope-success.json"
},
{
"type": "object",
"properties": {
"api_result": true
}
}
]
}Фрагмент: main-app://schemas/_shared/envelope-success.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/envelope-success.json",
"title": "Canonical success envelope",
"type": "object",
"required": ["api_code", "api_result"],
"properties": {
"api_code": { "const": 200 },
"api_result": true,
"empty": { "type": "boolean" }
},
"additionalProperties": false
}Страница не помогла?