API
/web_api/test_account/update_property
/web_api/test_account/update_property
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/test_account/update_property.request.json
REQUEST /web_api/test_account/update_property
| Name | Type | Required | Constraint |
|---|---|---|---|
test_account_id | integer | Yes | minimum 1 |
key | enum | Yes | "resource", "login", "password", "test_account_description" |
value | any | Yes | - |
Other top-level fields are not allowed.
Response
main-app://schemas/api_elements/test_account/update_property.response.json
RESPONSE /web_api/test_account/update_property
| 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 |
|---|---|---|---|
test_account_id | integer | No | minimum 0 |
project_id | integer | No | minimum 0 |
team_id | integer | No | minimum 0 |
resource | string | No | maxLength 350 |
login | string | No | maxLength 350 |
password | string | No | maxLength 350 |
test_account_description | string | No | maxLength 950 |
created_at | string | No | - |
updated_at | string | 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/test_account/update_property.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_account/update_property.request.json",
"title": "REQUEST /web_api/test_account/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_account_id",
"key",
"value"
],
"properties": {
"test_account_id": {
"type": "integer",
"minimum": 1
},
"key": {
"type": "string",
"enum": [
"resource",
"login",
"password",
"test_account_description"
]
},
"value": true
}
}Response: main-app://schemas/api_elements/test_account/update_property.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_account/update_property.response.json",
"title": "RESPONSE /web_api/test_account/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_account/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/test_account/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_account/row.json",
"title": "Row test_account",
"$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_account_id": {
"type": "integer",
"minimum": 0
},
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"resource": {
"type": "string",
"maxLength": 350
},
"login": {
"type": "string",
"maxLength": 350
},
"password": {
"type": "string",
"maxLength": 350
},
"test_account_description": {
"type": "string",
"maxLength": 950,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"created_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
},
"updated_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
}
}
}Did this page help?