metabase / metabase

The simplest, fastest way to get business intelligence and analytics to everyone in your company :yum:
https://metabase.com
Other
38.65k stars 5.14k forks source link

Not all Enterprise Edition endpoints follow naming convention #22687

Open camsaul opened 2 years ago

camsaul commented 2 years ago

Most of our EE endpoints follow the convention

/api/ee/:feature/whatever

e.g.

/api/ee/advanced-permissions/applications/graph

for

metabase-enterprise.advanced-permissions.api.application

Specifically the content-management and sandbox routes do not follow this convention (see metabase-enterprise.api.routes).

This makes it hard to automatically generate documentation for them.

Related: #22396

jeff-bruemmer commented 2 years ago

Just leaving a note here: @qnkhuat has put in a hotfix in the endpoint_dox script that generates our API docs to handle these discrepancies in API route format. Should we resolve this issue (that is #22687), we should verify that our API docs script correctly generates the endpoint routes.