API
/web_api/bug_relation/create
/web_api/bug_relation/create
This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.
Request
main-app://schemas/api_elements/bug_relation/create.request.json
REQUEST /web_api/bug_relation/create
| Name | Type | Required | Constraint |
|---|---|---|---|
relation_type | enum | Yes | "test_case_id", "test_run_id", "test_run_result_id", "execution_context_id", "checklist_id" |
bug_id | integer | Yes | minimum 0 |
element_id | integer | Yes | - |
Other top-level fields are not allowed.
Response
main-app://schemas/api_elements/bug_relation/create.response.json
RESPONSE /web_api/bug_relation/create
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | object | Yes | other fields allowed |
empty | boolean | No | - |
Other top-level fields are not allowed.
api_result
| Name | Type | Required | Constraint |
|---|---|---|---|
bug_relation_id | integer | No | minimum 0 |
relation_type | enum | No | "test_case_id", "test_run_id", "test_run_result_id", "execution_context_id", "checklist_id" |
bug_id | integer | No | minimum 0 |
element_id | integer | No | - |
Source schema
The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.
Request: main-app://schemas/api_elements/bug_relation/create.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug_relation/create.request.json",
"title": "REQUEST /web_api/bug_relation/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": {
"relation_type": {
"type": "string",
"enum": [
"test_case_id",
"test_run_id",
"test_run_result_id",
"execution_context_id",
"checklist_id"
]
},
"bug_id": {
"type": "integer",
"minimum": 0
},
"element_id": {
"type": "integer"
}
},
"required": [
"relation_type",
"bug_id",
"element_id"
]
}Response: main-app://schemas/api_elements/bug_relation/create.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug_relation/create.response.json",
"title": "RESPONSE /web_api/bug_relation/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_relation/row.json"
}
}
}
]
}Fragment: 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
}Fragment: main-app://schemas/api_elements/bug_relation/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/bug_relation/row.json",
"title": "Row bug_relation",
"$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_relation_id": {
"type": "integer",
"minimum": 0
},
"relation_type": {
"type": "string",
"enum": [
"test_case_id",
"test_run_id",
"test_run_result_id",
"execution_context_id",
"checklist_id"
]
},
"bug_id": {
"type": "integer",
"minimum": 0
},
"element_id": {
"type": "integer"
}
}
}Did this page help?