Каталог ресурсов
Всего операций: 253 в 18 разделах. Машинная спецификация — /openapi.draft.json.
Справочник не пишется руками: он собирается из спецификации при каждой сборке сайта, поэтому отстать от неё не может.
⚠️ Из 253 операций у 60 адрес предположительный — он выведен из сокращённой записи спецификации, а не написан в ней прямо. Такие операции помечены на своих страницах. Именно поэтому раздел называется «Проект API», а файл —
openapi.draft.json.
У 93 операций описание выведено из имени операции; операций совсем без описания не осталось. Спецификация написана каталогом путей, прозы для них там не было. Выведенная фраза строится по правилу «что операция возвращает или что меняет» — и ни слова о том, как она это делает. Адреса и параметры от этого не меняются.
| Раздел | Операций |
|---|---|
| Пользователи и доступ | 31 |
| Обучение | 57 |
| Коммерция | 45 |
| CRM, сегменты, сообщения | 25 |
| Сценарии (автоматизации) | 12 |
| Сценарии | 3 |
| Вебинары | 15 |
| Сайт и файлы | 17 |
| Аналитика | 5 |
| Служебное | 21 |
| Ключи API | 3 |
| Агент школы | 8 |
| Сегменты и теги | 2 |
| Массовое действие над сегментом | 1 |
| Вход из Telegram | 2 |
| Продажи: продукты, тарифы, заказы | 1 |
| Приём денег | 1 |
| Рассылки | 4 |
Чего в справочнике ещё нет #
Сказать это прямо честнее, чем показать пустое место.
Работающего API нет. По ADR-057 справочник выводится из OpenAPI, а OpenAPI — из zod-валидаторов на эндпоинтах. Публичного API в продукте пока не существует: маршрутов /v1/* нет ни одного, реализация назначена после среза 2 (ADR-054). Выводить поля не из чего, и проверить адреса тоже не обо что.
Чтобы справочник не был при этом пустым, пути и назначение операций собраны машинным разбором проектной спецификации 03-data/api-spec.md. Что из этого следует:
- пути, методы и коды ответа — это то, что спроектировано, и им можно верить как проекту, но не как работающему коду;
- 60 адресов выведены эвристикой из сокращений вида «
POST, PATCH, DELETE» и помечены на своих страницах словами «адрес предположительный»; - у 93 операций описание выведено из имени по правилу «что возвращает или что меняет» — такая фраза не содержит ни одного утверждения о поведении, которого нет в спецификации, и помечена
x-lms-derived-summary; - у 0 операций описания нет вовсе — из имени оно не следует (
replay,pause,grant-retry), а угадывать поведение мы не станем; - тела запросов и ответов не показаны нигде — вместо выдуманного примера стоит пометка «чего здесь нет»;
- форма ошибки описана полностью и по-настоящему: она задана в спецификации целиком, см. Ошибки.
Как только появятся валидаторы, openapi.json начнёт собираться из них, а эти страницы пересоберутся сами — их адреса и заголовки не изменятся.