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

/web_api/auth/logout

/web_api/auth/logout ​

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

Запрос ​

main-app://schemas/api_auth/logout.request.json

POST /web_api/auth/logout body

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

Ответ ​

main-app://schemas/api_auth/logout.response.json

POST /web_api/auth/logout success

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

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

api_result ​

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

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

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

Запрос: main-app://schemas/api_auth/logout.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_auth/logout.request.json",
  "title": "POST /web_api/auth/logout body",
  "type": "object",
  "required": [],
  "additionalProperties": true,
  "properties": []
}
Ответ: main-app://schemas/api_auth/logout.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_auth/logout.response.json",
  "title": "POST /web_api/auth/logout success",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.json" },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "required": ["message"],
          "additionalProperties": false,
          "properties": {
            "message": { "type": "string" }
          }
        }
      }
    }
  ]
}
Фрагмент: 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

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