Рецепты

Рецепт — одна задача от начала до конца: вызовы в том порядке, в котором их делают, ответ, который каждый из них действительно возвращает (в сокращении), и проверка в конце, по которой видно, что всё получилось. Справочные страницы описывают каждое поле; рецепт показывает только путь через них.

Во всех примерах две переменные окружения из быстрого старта: $OP_TOKEN — личный токен op_, $BASE — базовый адрес API v2. Сайт выбирается полем blog_id в теле или заголовком X-OnPress-Blog-Id, как описано в аутентификации.

Рецепты

• Создать страницу — опубликовать markdown в раздел, прочитать ответ, обновить ту же страницу, перевести черновик в публикацию и поставить страницу на место в дереве документации.
• Оболочка со шапкой и подвалом — залить site__header, site__footer и оболочку article, которая их подключает, и поставить в неё страницу.
• FAQ из данных — один набор faq на весь сайт с фильтром по странице, разметкой FAQPage и без блока там, где вопросов нет.
• Перевод страницы — опубликовать перевод с translation_of, проверить группу, связать существующие страницы, перевести наборы данных и меню.
• Загрузить картинку — положить файл в медиатеку по адресу или в base64, вставить в markdown и поставить иконку сайта.
• Переименовать фрейм — перевести старый транслитерированный слаг на имена вида block__element, не сломав фреймы и страницы, которые его используют.

Перед началом

Каждая запись в рецептах настоящая. Где ручка поддерживает dry_run, рецепт сначала показывает его: ответ той же формы, что у настоящей записи, с "applied": false, и ничего не сохраняется. Ручки без dry_run (загрузка медиа, переименование фрейма, группы переводов) либо безопасно повторяются, либо отказывают до записи; в каждом рецепте сказано, какой случай.

Ошибка приходит как {"success": false, "error": "<код>", "message": "…"}; ветвиться нужно по error. Полный список — на странице ошибок.