Max OpenAPI Schema

Актуальная OpenAPI-схема Max Bot API в JSON и YAML.

Files

• openapi.json - текущая JSON-схема
• openapi.yaml - текущая YAML-схема
• schemas/ - архив версий схемы
• public/ - исходники статического сайта вместе со Swagger

Updates

Парсер находится в ветке parser. Из рабочей копии этой ветки схема обновляется командами:

make schema-update
make schema-status
make schema-diff
make schema-commit

Web - local preview

Собрать статический сайт:

./scripts/build-site.sh

Для загрузки схемы браузер должен открыть страницу через HTTP, а не как файл. Например:

npx serve dist

После запуска открыть http://localhost:3000/.

• http://localhost:3000/swagger/ - Swagger UI.
• http://localhost:3000/scalar/ - Scalar API Reference.

Automatic updates

Workflow .github/workflows/update-schema.yml запускается вручную и два раза в день: в 06:18 и 18:18 по МСК. Он получает код из ветки parser, обновляет схему в ветке schema и создает коммит только при изменениях. После обновления schema workflow также публикует новую версию GitHub Pages.