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

/web_api/public/text_document/report

/web_api/public/text_document/report ​

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

Запрос ​

main-app://schemas/api_public_text_document/report.request.json

POST /web_api/public/text_document/report body

ИмяТипОбязательноеОграничение
tokenstringНет-
share_tokenstringНет-
reasonstringНет-
reporter_emailstringНет-
emailstringНет-
passwordstringНет-

Другие поля верхнего уровня допустимы.

Ответ ​

main-app://schemas/api_public_text_document/report.response.json

POST /web_api/public/text_document/report success

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

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

api_result ​

ИмяТипОбязательноеОграничение
acceptedbooleanДа-

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

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

Запрос: main-app://schemas/api_public_text_document/report.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_public_text_document/report.request.json",
  "title": "POST /web_api/public/text_document/report body",
  "type": "object",
  "required": [],
  "additionalProperties": true,
  "properties": {
    "token": {
      "type": "string"
    },
    "share_token": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    },
    "reporter_email": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "password": {
      "type": "string"
    }
  }
}
Ответ: main-app://schemas/api_public_text_document/report.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_public_text_document/report.response.json",
  "title": "POST /web_api/public/text_document/report success",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "accepted"
          ],
          "properties": {
            "accepted": {
              "type": "boolean"
            }
          }
        }
      }
    }
  ]
}
Фрагмент: 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

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