Покрытие endpoint'ов документацией и схемой¶
Матрица ниже фиксирует текущий охват HTTP endpoint'ов сервиса:
- отражён ли endpoint в MkDocs-страницах;
- отражён ли endpoint в OpenAPI-схеме.
Публичные и административные endpoints¶
| Endpoint | Контроллер | Docs | OpenAPI |
|---|---|---|---|
GET /api/metabase/widgets |
MetabaseWidgetsController |
Да | Да |
GET /api/metabase/widgets/{id} |
MetabaseWidgetsController |
Да | Да |
GET /api/metabase/widgets/by-ids |
MetabaseWidgetsController |
Да | Да |
GET /api/metabase/settings/widgets/access |
MetabaseSettingsController |
Да | Да |
PATCH /api/metabase/settings/widgets/access |
MetabaseSettingsController |
Да | Да |
GET /api/metabase/settings/admin/users |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/is-admin |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/build-info |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/sql/preview |
AdminAccessController |
Да | Да |
POST /api/metabase/settings/admin/sql/export |
AdminAccessController |
Да | Да |
POST /api/metabase/settings/admin/sql/publish |
AdminAccessController |
Да | Да |
POST /api/metabase/settings/admin/sql/deploy |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/tags |
AdminAccessController |
Да | Да |
POST /api/metabase/settings/admin/tags |
AdminAccessController |
Да | Да |
DELETE /api/metabase/settings/admin/tags/{tagId} |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/on-prem-boxes |
AdminAccessController |
Да | Да |
POST /api/metabase/settings/admin/on-prem-boxes |
AdminAccessController |
Да | Да |
DELETE /api/metabase/settings/admin/on-prem-boxes/{id} |
AdminAccessController |
Да | Да |
PUT /api/metabase/settings/admin/users/{userId}/tags |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/users/{userId}/tags/{tagId}/subfolders |
AdminAccessController |
Да | Да |
PUT /api/metabase/settings/admin/users/{userId}/tags/{tagId}/subfolders |
AdminAccessController |
Да | Да |
GET /api/metabase/settings/admin/widgets/access |
AdminAccessController |
Да | Да |
PATCH /api/metabase/settings/admin/widgets/access |
AdminAccessController |
Да | Да |
GET /api/metabase/favorites |
MetabaseFavoritesController |
Да | Да |
POST /api/metabase/favorites/items |
MetabaseFavoritesController |
Да | Да |
DELETE /api/metabase/favorites/items/{targetType}/{targetId} |
MetabaseFavoritesController |
Да | Да |
PATCH /api/metabase/favorites/items/{itemId}/reorder |
MetabaseFavoritesController |
Да | Да |
PATCH /api/metabase/favorites/nodes/{nodeType}/{nodeId}/reorder |
MetabaseFavoritesController |
Да | Да |
POST /api/metabase/favorites/groups |
MetabaseFavoritesController |
Да | Да |
PATCH /api/metabase/favorites/groups/{groupId} |
MetabaseFavoritesController |
Да | Да |
DELETE /api/metabase/favorites/groups/{groupId} |
MetabaseFavoritesController |
Да | Да |
POST /api/metabase/action-buttons/analytics-request |
MetabaseController |
Да | Да |
POST /api/internal/metabase/deploy |
InternalMetabaseDeployController |
Да | Да |
Инфраструктурные endpoints¶
| Endpoint | Контроллер | Docs | OpenAPI |
|---|---|---|---|
GET /api/docs |
DocsRedirectController |
Нет, сознательно | Нет, сознательно |
/api/docs — это инфраструктурный redirect на web-документацию, а не бизнес-API приложения, поэтому он не
включён в OpenAPI и не описывается как продуктовый endpoint.