Схемы¶

Эндпоинты для получения схем, используемых для шаблонов страниц, учётных записей пользователей, групп, плагинов, тем, конфигурации и определений разрешений, а также GET /blueprint-files, который перечисляет файлы для полей выбора папки схемы. Загрузка и удаление файлов для полей схемы с типом file описаны в разделе Медиафайлы: POST /blueprint-upload и DELETE /blueprint-upload.

Список типов страниц¶

GET /blueprints/pages

Выводит шаблоны страниц (схемы), доступные для новых страниц, после применения хуков onAdminPageTypes / onAdminModularPageTypes и настроенных скрытых типов. Требуется api.pages.read.

Параметры

Ответ

{"data": [{"type": "default", "label": "Default"}, {"type": "blog", "label": "Blog"}, {"type": "post", "label": "Post"}]}

Коды ответов

Получение схемы страницы¶

GET /blueprints/pages/{template}

Возвращает полностью разрешённую схему для шаблона страницы, включая унаследованные поля и импорты. Требуется api.pages.read. Вызывает onApiBlueprintResolved с context: page, чтобы плагины могли скорректировать сериализованные поля.

Параметры

Ответ

{"data": {"name": "default", "title": "Default", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "header.title", "type": "text", "label": "Title"}]}}

Коды ответов

Получение схемы пользователя¶

GET /blueprints/users

Возвращает схему учётной записи пользователя для рендеринга формы редактирования пользователя. Нужно только api.access, так как каждый вошедший пользователь рендерит с её помощью форму своего профиля. Вызывает onApiBlueprintResolved с context: account.

Ответ

{"data": {"name": "account", "title": "Account", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "username", "type": "text", "label": "Username"}]}}

Коды ответов

Получение разрешений¶

GET /blueprints/users/permissions

Возвращает все зарегистрированные в системе действия разрешений, организованные иерархически с переведёнными метками. Требуется api.users.read. Ключ children появляется только у действий, у которых есть дочерние действия.

Ответ

{"data": [{"name": "admin", "label": "Admin", "children": [{"name": "admin.login", "label": "Login"}]}]}

Коды ответов

Получение схемы страницы плагина¶

GET /blueprints/plugins/{plugin}/pages/{pageId}

Возвращает пользовательскую схему страницы для плагина. Требуется api.config.read. Загружает YAML-файл из admin/blueprints/{pageId}.yaml в папке плагина и возвращает его как сериализованную схему с разрешёнными полями. Если этот файл отсутствует, а pageId совпадает со slug плагина, вместо него используется основной blueprints.yaml плагина. Вызывает onApiBlueprintResolved с context: plugin-page.

Параметры

Ответ

{"data": {"name": "licenses", "title": "Licenses", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "licenses", "type": "array", "label": "Licenses"}]}}

Коды ответов

Получение схемы плагина¶

GET /blueprints/plugins/{plugin}

Возвращает blueprints.yaml плагина с разрешёнными полями (метки переведены, параметры данных раскрыты). Требуется api.config.read. Вызывает событие onApiBlueprintResolved с context: plugin, чтобы плагины могли изменить сериализованные поля (например, добавить динамические параметры).

Параметры

Ответ

{"data": {"name": "simplesearch", "title": "SimpleSearch", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "enabled", "type": "toggle", "label": "Plugin status"}]}}

Коды ответов

Получение схемы темы¶

GET /blueprints/themes/{theme}

Возвращает blueprints.yaml темы с разрешёнными полями. Требуется api.config.read. Вызывает onApiBlueprintResolved с context: theme.

Параметры

Ответ

{"data": {"name": "quark", "title": "Quark", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "dropdown.enabled", "type": "toggle", "label": "Dropdown in navbar"}]}}

Коды ответов

Получение схемы конфигурации¶

GET /blueprints/config/{scope}

Возвращает схему, описывающую область конфигурации system/site. Admin2 использует её вместе с GET /config/{scope} для рендеринга форм конфигурации. Ищет схему через поток blueprints://, чтобы учитывались переопределения плагинов (например, media.yaml плагина admin), а затем откатывается к system://blueprints/config/{scope}.yaml.

Параметры

Ответ

{"data": {"name": "system", "title": "System Configuration", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "cache.enabled", "type": "toggle", "label": "Caching"}]}}

Коды ответов

Разрешение параметров данных¶

GET /data/resolve

Разрешает директивы data-options@: \Some\Class::method, используемые в определениях полей схемы (например, список шаблонов страниц, список тем). Admin2 вызывает его при рендеринге схемы, поле select/checkboxes которой ссылается на вызываемый метод. Принимаются только вызываемые методы Class::method из белого списка утверждённых поставщиков данных (Blueprint::isSafeDynamicCall()) — белый список с точным совпадением предотвращает выполнение произвольного кода. Поставщики ядра утверждены заранее; плагины и темы регистрируют свои через Blueprint::addAllowedDynamicCallable() при запуске. Результаты нормализуются до [{value, label}] для использования с select.

Параметры

Ответ

{"data": [{"value": "default", "label": "Default"}, {"value": "blog", "label": "Blog"}]}

Коды ответов

Получение схемы группы¶

GET /blueprints/groups

Возвращает схему редактирования группы пользователей (user/group.yaml, разрешается через поток blueprints://, поэтому переопределения сайта применяются). Требуется api.users.read. Вызывает onApiBlueprintResolved с context: group.

Ответ

{"data": {"name": "group", "title": "Group", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "readableName", "type": "text", "label": "Display Name"}]}}

Коды ответов

Получение схемы новой группы¶

GET /blueprints/groups/new

Возвращает схему создания группы пользователей (user/group_new.yaml, разрешается через поток blueprints://, поэтому переопределения сайта применяются). Требуется api.users.read. Вызывает onApiBlueprintResolved с context: group_new.

Ответ

{"data": {"name": "group_new", "title": "Add Group", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "groupname", "type": "text", "label": "Group Name"}]}}

Коды ответов

Получение схемы конфигурации учётных записей¶

GET /blueprints/config/accounts

Возвращает схему конфигурации учётных записей Flex — форму на вкладке «Конфигурация» страницы «Пользователи». Требуется api.config.read. Строится по той же схеме директории Flex, что использует классическая админка, поэтому включает общую вкладку кэширования наряду с настройками учётных записей пользователей. Используйте её вместе с GET /config/accounts. Вызывает onApiBlueprintResolved с context: config и template: accounts.

Ответ

{"data": {"name": "accounts", "title": "Accounts Configuration", "type": null, "child_type": null, "validation": "loose", "fields": [{"name": "object.cache.index.enabled", "type": "toggle", "label": "Enable Index Caching"}]}}

Коды ответов

Список файлов папки схемы¶

GET /blueprint-files

Выводит файлы в папке, на которую указывает поле схемы со своим параметром folder: (filepicker, mediapicker), как taskGetFilesInFolder в классической админке. Требуется api.media.read.

Параметры

Ответ

{"data": [{"filename": "logo.png", "url": "/user/themes/quark/images/logo.png", "type": "image/png", "size": 18432, "dimensions": {"width": 400, "height": 120}, "thumbnail_url": "/api/v1/thumbnails/3f2a9c1e4b5d6a7f8e9d0c1b2a394857.png", "modified": "2026-09-01T10:15:00+00:00"}], "meta": {"pagination": {"page": 1, "per_page": 1, "total": 1, "total_pages": 1}, "folder": "themes/quark/images", "scope": null, "exists": true}, "links": {"self": "/api/v1/blueprint-files?page=1&per_page=1"}}

Коды ответов

Результат использует обёртку с постраничной разбивкой, но на самом деле никогда не разбивается на страницы: все подходящие файлы приходят на странице 1.

Литералы медиафайлов страницы @self и self@ (без подпути) здесь не обрабатываются, так как у клиента уже есть медиафайлы страницы из GET /pages/{route}/media. Они возвращают стандартную ошибку валидации 422, в записи errors для folder которой стоит сообщение PAGE_MEDIA_ONLY:

{"status": 422, "title": "Unprocessable Entity", "detail": "Use /pages/{route}/media for @self / self@ folders.", "errors": [{"field": "folder", "message": "PAGE_MEDIA_ONLY"}]}