Программный интерфейс

/web_api/text_document/delete

/web_api/text_document/delete ​

Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.

Запрос ​

main-app://schemas/api_text_document/text_document/delete.request.json

REQUEST /web_api/text_document/delete

ИмяТипОбязательноеОграничение
*anyНетдругие поля допустимы

Ответ ​

main-app://schemas/api_text_document/text_document/delete.response.json

RESPONSE /web_api/text_document/delete

ИмяТипОбязательноеОграничение
api_codeintegerДаconst 200
api_resultanyДа-
emptybooleanНет-

Другие поля верхнего уровня запрещены.

Исходная схема ​

Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.

Запрос: main-app://schemas/api_text_document/text_document/delete.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_text_document/text_document/delete.request.json",
  "title": "REQUEST /web_api/text_document/delete",
  "$ref": "main-app://schemas/_shared/json-object.request.json"
}
Фрагмент: main-app://schemas/_shared/json-object.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/json-object.request.json",
  "title": "JSON object body, fields vary by operation",
  "type": "object",
  "additionalProperties": true
}
Ответ: main-app://schemas/api_text_document/text_document/delete.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_text_document/text_document/delete.response.json",
  "title": "RESPONSE /web_api/text_document/delete",
  "$ref": "main-app://schemas/_shared/any.response.json"
}
Фрагмент: main-app://schemas/_shared/any.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/any.response.json",
  "title": "Success envelope, api_result not narrowed yet",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.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
}

Версия 1.0.0 · Последнее изменение 2026-10-07

Страница не помогла?