Программный интерфейс
/web_api/bug/create
/web_api/bug/create
Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.
Запрос
main-app://schemas/api_elements/bug/create.request.json
REQUEST /web_api/bug/create
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
project_id | integer | Да | minimum 0 |
team_id | integer | Да | minimum 0 |
bug_title | string | Нет | maxLength 500 |
bug_description | string | Нет | maxLength 2500 |
bug_reproduction_steps | string | Нет | maxLength 2500 |
bug_actual_result | string | Нет | maxLength 2500 |
bug_expected_result | string | Нет | maxLength 2500 |
bug_type | enum | Нет | "BUG", "REGRESSION", "PERFORMANCE", "SECURITY", "USABILITY", "COMPATIBILITY", "DOCUMENTATION", "OTHER" |
bug_status | enum | Нет | "OPEN", "TRIAGE", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "CLOSED", "REOPENED" |
bug_resolution | enum | Нет | "FIXED", "WONT_FIX", "DUPLICATE", "CANNOT_REPRODUCE", "WORKS_AS_DESIGNED", "DEFERRED", "NOT_A_BUG" |
bug_priority | enum | Нет | "CRITICAL", "HIGH", "NORMAL", "LOW" |
bug_severity | enum | Нет | "BLOCKER", "CRITICAL", "MAJOR", "MINOR", "TRIVIAL" |
reporter_id | integer | null | Нет | - |
assigned_to | integer | null | Нет | - |
bug_build_version | string | null | Нет | maxLength 100 |
bug_affected_version | string | null | Нет | maxLength 100 |
bug_fixed_version | string | null | Нет | maxLength 100 |
duplicate_of_id | integer | Нет | minimum 0 |
created_at | string | Нет | - |
updated_at | string | Нет | - |
completed_at | string | Нет | - |
Другие поля верхнего уровня запрещены.
Ответ
main-app://schemas/api_elements/bug/create.response.json
RESPONSE /web_api/bug/create
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
api_code | integer | Да | const 200 |
api_result | object | Да | другие поля допустимы |
empty | boolean | Нет | - |
Другие поля верхнего уровня запрещены.
api_result
| Имя | Тип | Обязательное | Ограничение |
|---|---|---|---|
bug_id | integer | Нет | minimum 0 |
project_id | integer | Нет | minimum 0 |
team_id | integer | Нет | minimum 0 |
bug_title | string | Нет | maxLength 500 |
bug_description | string | Нет | maxLength 2500 |
bug_reproduction_steps | string | Нет | maxLength 2500 |
bug_actual_result | string | Нет | maxLength 2500 |
bug_expected_result | string | Нет | maxLength 2500 |
bug_type | enum | Нет | "BUG", "REGRESSION", "PERFORMANCE", "SECURITY", "USABILITY", "COMPATIBILITY", "DOCUMENTATION", "OTHER" |
bug_status | enum | Нет | "OPEN", "TRIAGE", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "CLOSED", "REOPENED" |
bug_resolution | enum | Нет | "FIXED", "WONT_FIX", "DUPLICATE", "CANNOT_REPRODUCE", "WORKS_AS_DESIGNED", "DEFERRED", "NOT_A_BUG" |
bug_priority | enum | Нет | "CRITICAL", "HIGH", "NORMAL", "LOW" |
bug_severity | enum | Нет | "BLOCKER", "CRITICAL", "MAJOR", "MINOR", "TRIVIAL" |
reporter_id | integer | null | Нет | - |
assigned_to | integer | null | Нет | - |
bug_build_version | string | null | Нет | maxLength 100 |
bug_affected_version | string | null | Нет | maxLength 100 |
bug_fixed_version | string | null | Нет | maxLength 100 |
duplicate_of_id | integer | Нет | minimum 0 |
created_at | string | Нет | - |
updated_at | string | Нет | - |
completed_at | string | Нет | - |
Исходная схема
Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.
Запрос: main-app://schemas/api_elements/bug/create.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug/create.request.json",
"title": "REQUEST /web_api/bug/create",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": false,
"properties": {
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"bug_title": {
"type": "string",
"maxLength": 500
},
"bug_description": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_reproduction_steps": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_actual_result": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_expected_result": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_type": {
"type": "string",
"enum": [
"BUG",
"REGRESSION",
"PERFORMANCE",
"SECURITY",
"USABILITY",
"COMPATIBILITY",
"DOCUMENTATION",
"OTHER"
]
},
"bug_status": {
"type": "string",
"enum": [
"OPEN",
"TRIAGE",
"IN_PROGRESS",
"ON_HOLD",
"RESOLVED",
"CLOSED",
"REOPENED"
]
},
"bug_resolution": {
"type": "string",
"enum": [
"FIXED",
"WONT_FIX",
"DUPLICATE",
"CANNOT_REPRODUCE",
"WORKS_AS_DESIGNED",
"DEFERRED",
"NOT_A_BUG"
]
},
"bug_priority": {
"type": "string",
"enum": [
"CRITICAL",
"HIGH",
"NORMAL",
"LOW"
]
},
"bug_severity": {
"type": "string",
"enum": [
"BLOCKER",
"CRITICAL",
"MAJOR",
"MINOR",
"TRIVIAL"
]
},
"reporter_id": {
"type": [
"integer",
"null"
]
},
"assigned_to": {
"type": [
"integer",
"null"
]
},
"bug_build_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bug_affected_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bug_fixed_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"duplicate_of_id": {
"type": "integer",
"minimum": 0
},
"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"
}
},
"required": [
"project_id",
"team_id"
]
}Ответ: main-app://schemas/api_elements/bug/create.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug/create.response.json",
"title": "RESPONSE /web_api/bug/create",
"$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/bug/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/bug/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug/row.json",
"title": "Row bug",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"properties": {
"bug_id": {
"type": "integer",
"minimum": 0
},
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"bug_title": {
"type": "string",
"maxLength": 500
},
"bug_description": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_reproduction_steps": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_actual_result": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_expected_result": {
"type": "string",
"maxLength": 2500,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"bug_type": {
"type": "string",
"enum": [
"BUG",
"REGRESSION",
"PERFORMANCE",
"SECURITY",
"USABILITY",
"COMPATIBILITY",
"DOCUMENTATION",
"OTHER"
]
},
"bug_status": {
"type": "string",
"enum": [
"OPEN",
"TRIAGE",
"IN_PROGRESS",
"ON_HOLD",
"RESOLVED",
"CLOSED",
"REOPENED"
]
},
"bug_resolution": {
"type": "string",
"enum": [
"FIXED",
"WONT_FIX",
"DUPLICATE",
"CANNOT_REPRODUCE",
"WORKS_AS_DESIGNED",
"DEFERRED",
"NOT_A_BUG"
]
},
"bug_priority": {
"type": "string",
"enum": [
"CRITICAL",
"HIGH",
"NORMAL",
"LOW"
]
},
"bug_severity": {
"type": "string",
"enum": [
"BLOCKER",
"CRITICAL",
"MAJOR",
"MINOR",
"TRIVIAL"
]
},
"reporter_id": {
"type": [
"integer",
"null"
]
},
"assigned_to": {
"type": [
"integer",
"null"
]
},
"bug_build_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bug_affected_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"bug_fixed_version": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"duplicate_of_id": {
"type": "integer",
"minimum": 0
},
"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"
}
}
}Страница не помогла?