Программный интерфейс
/web_api/test_run_result/update_property
/web_api/test_run_result/update_property
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_elements/test_run_result/update_property.request.json
REQUEST /web_api/test_run_result/update_property
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
test_run_result_id | integer | Да | minimum 1 |
key | enum | Да | "test_case_id", "test_run_id", "test_result_status", "test_result_description", "assigned_to", "completed_at" |
value | any | Да | - |
Другие поля верхнего уровня запрещены.
Ответ
main-app://schemas/api_elements/test_run_result/update_property.response.json
RESPONSE /web_api/test_run_result/update_property
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
api_code | integer | Да | const 200 |
api_result | object | Да | другие поля допустимы |
empty | boolean | Нет | - |
Другие поля верхнего уровня запрещены.
api_result
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
test_run_result_id | integer | Нет | minimum 0 |
test_case_id | integer | Нет | minimum 0 |
test_run_id | integer | Нет | minimum 0 |
test_result_status | enum | Нет | "PENDING", "PASSED", "FAILED", "SKIPPED", "BLOCKED", "RETEST" |
test_result_description | string | Нет | maxLength 3500 |
project_id | integer | Нет | minimum 0 |
team_id | integer | Нет | minimum 0 |
assigned_to | integer | null | Нет | - |
created_at | string | Нет | - |
updated_at | string | Нет | - |
completed_at | string | Нет | - |
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_elements/test_run_result/update_property.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_run_result/update_property.request.json",
"title": "REQUEST /web_api/test_run_result/update_property",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": false,
"required": [
"test_run_result_id",
"key",
"value"
],
"properties": {
"test_run_result_id": {
"type": "integer",
"minimum": 1
},
"key": {
"type": "string",
"enum": [
"test_case_id",
"test_run_id",
"test_result_status",
"test_result_description",
"assigned_to",
"completed_at"
]
},
"value": true
}
}Ответ: main-app://schemas/api_elements/test_run_result/update_property.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_run_result/update_property.response.json",
"title": "RESPONSE /web_api/test_run_result/update_property",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"allOf": [
{
"$ref": "main-app://schemas/_shared/envelope-success.json"
},
{
"type": "object",
"properties": {
"api_result": {
"$ref": "main-app://schemas/api_elements/test_run_result/row.json"
}
}
}
]
}Фрагмент: 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
}Фрагмент: main-app://schemas/api_elements/test_run_result/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_run_result/row.json",
"title": "Row test_run_result",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"properties": {
"test_run_result_id": {
"type": "integer",
"minimum": 0
},
"test_case_id": {
"type": "integer",
"minimum": 0
},
"test_run_id": {
"type": "integer",
"minimum": 0
},
"test_result_status": {
"type": "string",
"enum": [
"PENDING",
"PASSED",
"FAILED",
"SKIPPED",
"BLOCKED",
"RETEST"
]
},
"test_result_description": {
"type": "string",
"maxLength": 3500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"assigned_to": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
},
"updated_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
},
"completed_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
}
}
}Страница не помогла?