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

/web_api/app_config

/web_api/app_config ​

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

Запрос ​

main-app://schemas/api_app/app_config.request.json

REQUEST /web_api/app_config

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

Ответ ​

main-app://schemas/api_app/app_config.response.json

GET|POST /web_api/app_config success

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

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

api_result ​

ИмяТипОбязательноеОграничение
min_supported_versionstringДа-
latest_versionstringДа-
update_urlobjectДадругие поля запрещены
maintenancebooleanДа-
maintenance_messagestringДа-
app_versionstringДа-
platformenumДа"ios", "android"

api_result.update_url ​

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

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

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

Запрос: main-app://schemas/api_app/app_config.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_app/app_config.request.json",
  "title": "REQUEST /web_api/app_config",
  "$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_app/app_config.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_app/app_config.response.json",
  "title": "GET|POST /web_api/app_config success",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.json" },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "required": [
            "min_supported_version",
            "latest_version",
            "update_url",
            "maintenance",
            "maintenance_message",
            "app_version",
            "platform"
          ],
          "additionalProperties": false,
          "properties": {
            "min_supported_version": { "type": "string" },
            "latest_version": { "type": "string" },
            "update_url": {
              "type": "object",
              "required": ["ios", "android"],
              "additionalProperties": false,
              "properties": {
                "ios": { "type": "string" },
                "android": { "type": "string" }
              }
            },
            "maintenance": { "type": "boolean" },
            "maintenance_message": { "type": "string" },
            "app_version": { "type": "string" },
            "platform": { "type": "string", "enum": ["ios", "android"] }
          }
        }
      }
    }
  ]
}
Фрагмент: 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

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