hints.schema

Scope: hints

Кто может вызывать: авторизованный пользователь с правом чтения модуля (RestAccess::requireRead())

Возвращает JSON-схему всех зарегистрированных методов hints.*: HTTP-метод, параметры, коды ошибок, controller/action.

HTTP: GET

Побочные эффекты: none

Параметры метода

Нет.

Возвращаемые данные

result.result — объект:

Поле Тип Описание
scope string hints
prefix string hints.
fetchAllMax int Защитный лимит для fetchAll (5000)
methods array Список методов с method, http, params, errors, controller, action

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
MODULE_DISABLED Модуль выключен на сайте
ACCESS_DENIED Нет права чтения
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса

curl -G "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.schema.json" \
          -H "Accept: application/json"

Пример ответа

{
          "result": {
            "result": {
              "scope": "hints",
              "prefix": "hints.",
              "fetchAllMax": 5000,
              "methods": [
                {
                  "method": "hints.config.get",
                  "http": "GET",
                  "params": [
                    {
                      "name": "siteId",
                      "type": "string",
                      "required": false,
                      "description": "Site ID (omit to return all active sites)"
                    }
                  ],
                  "errors": [
                    { "code": "UNAUTHORIZED", "description": "User is not authorized" }
                  ],
                  "controller": "Config",
                  "action": "getAction"
                }
              ]
            },
            "error": null
          }
        }

Полный список методов (20 шт.) — в массиве methods ответа со стенда; фрагмент приведён для формы.

См. также

Предыдущая
Обзор раздела
Следующая
Обзор раздела