dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 01:15:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: update mgmt api docs (#49743)

Browse Source 
This PR updates Management API docs automatically.

This regenerates:

- Management API specs and sections
- Personal Access Tokens permission-to-endpoint table
- Personal Access Tokens MCP tool permissions table

Sources include the live Management API specs, MCP permission map,
and Studio's shared permission catalog.

Co-authored-by: zamotany <17573635+zamotany@users.noreply.github.com>
This commit is contained in:
supabase-supabase-autofixer[bot]andzamotany authored and GitHub committed 2026-09-30 18:34:09 +02:00
1 parent c44d053aec
commit e54394cfd8
8 files changed
+3608 -6407
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx
+36 -35
View File
@@ -1,37 +1,38 @@
{/* Generated by `make -C apps/docs/spec generate.partials.access-control`. Do not hand-edit; see supabase/platform#37175 and apps/docs/spec/Makefile. */}
| MCP tool | Required permission |
| --------------------------- | ----------------------------------------------------------------------------- |
| `apply_migration` | **Migrations** (Read-write) |
| `confirm_cost` | None (always available) |
| `create_branch` | **Development Branches** (Read-write) or **Production Branches** (Read-write) |
| `create_project` | **Organization Projects** (Read-write) |
| `delete_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `deploy_edge_function` | **Edge Functions** (Read-write) |
| `execute_sql` | **Database** (Read) |
| `generate_typescript_types` | **Database** (Read) |
| `get_advisors` | **Advisors** (Read) |
| `get_cost` | **Organization Settings** (Read) and **Projects (account-wide)** (Read) |
| `get_edge_function` | **Edge Functions** (Read) |
| `get_logs` | **Logs** (Read) |
| `get_organization` | **Organization Settings** (Read) |
| `get_project` | **Project Settings** (Read) |
| `get_project_url` | **Project Settings** (Read) |
| `get_publishable_keys` | **API Keys** (Read) |
| `get_storage_config` | **Storage Config** (Read) |
| `list_branches` | **Development Branches** (Read) or **Production Branches** (Read) |
| `list_edge_functions` | **Edge Functions** (Read) |
| `list_extensions` | **Database** (Read) |
| `list_migrations` | **Migrations** (Read) |
| `list_organizations` | **Organizations** (Read) |
| `list_projects` | **Projects (account-wide)** (Read) |
| `list_storage_buckets` | **Storage** (Read) |
| `list_tables` | **Database** (Read) |
| `merge_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `pause_project` | **Project Settings** (Read-write) |
| `query_logs` | **Logs** (Read) |
| `rebase_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `reset_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `restore_project` | **Project Settings** (Read-write) |
| `search_docs` | None (always available) |
| `update_storage_config` | **Storage Config** (Read-write) |
| MCP tool | Required permission |
| ----------------------------- | ----------------------------------------------------------------------------- |
| `apply_migration` | **Migrations** (Read-write) |
| `confirm_cost` | None (always available) |
| `create_branch` | **Development Branches** (Read-write) or **Production Branches** (Read-write) |
| `create_edge_function_secret` | **Edge Function Secrets** (Read-write) and **Edge Function Secrets** (Read) |
| `create_project` | **Organization Projects** (Read-write) |
| `delete_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `deploy_edge_function` | **Edge Functions** (Read-write) |
| `execute_sql` | **Database** (Read) |
| `generate_typescript_types` | **Database** (Read) |
| `get_advisors` | **Advisors** (Read) |
| `get_cost` | **Organization Settings** (Read) and **Projects (account-wide)** (Read) |
| `get_edge_function` | **Edge Functions** (Read) |
| `get_logs` | **Logs** (Read) |
| `get_organization` | **Organization Settings** (Read) |
| `get_project` | **Project Settings** (Read) |
| `get_project_url` | **Project Settings** (Read) |
| `get_publishable_keys` | **API Keys** (Read) |
| `get_storage_config` | **Storage Config** (Read) |
| `list_branches` | **Development Branches** (Read) or **Production Branches** (Read) |
| `list_edge_functions` | **Edge Functions** (Read) |
| `list_extensions` | **Database** (Read) |
| `list_migrations` | **Migrations** (Read) |
| `list_organizations` | **Organizations** (Read) |
| `list_projects` | **Projects (account-wide)** (Read) |
| `list_storage_buckets` | **Storage** (Read) |
| `list_tables` | **Database** (Read) |
| `merge_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `pause_project` | **Project Settings** (Read-write) |
| `query_logs` | **Logs** (Read) |
| `rebase_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `reset_branch` | **Production Branches** (Read-write) or **Development Branches** (Read-write) |
| `restore_project` | **Project Settings** (Read-write) |
| `search_docs` | None (always available) |
| `update_storage_config` | **Storage Config** (Read-write) |
apps/docs/content/_partials/access-control/scoped_pat_permissions.mdx
+10 -5
View File
@@ -54,6 +54,11 @@
| | | [Retry delivery](/docs/reference/api/v2-projects-ref-webhooks-deliveries-id-retry-post) |
| | | [Send test event](/docs/reference/api/v2-projects-ref-webhooks-endpoints-id-test-post) |
| | | [Update endpoint](/docs/reference/api/v2-projects-ref-webhooks-endpoints-id-patch) |
| Notebooks | Read | [Get notebook](/docs/reference/api/v2-get-notebook) |
| | | [List notebooks](/docs/reference/api/v2-list-notebooks) |
| | Read-write | [Create notebook](/docs/reference/api/v2-create-notebook) |
| | | [Delete notebook](/docs/reference/api/v2-delete-notebook) |
| | | [Update notebook](/docs/reference/api/v2-update-notebook) |
| **Database** | | |
| Backups | Read | [Get backup schedule](/docs/reference/api/v1-get-backup-schedule) |
| | | [List all backups](/docs/reference/api/v1-list-all-backups) |
@@ -156,11 +161,11 @@
| Storage Config | Read | [Get project config](/docs/reference/api/v2-get-project-config)[^5] |
| | | [Get storage config](/docs/reference/api/v1-get-storage-config) |
| | Read-write | [Update storage config](/docs/reference/api/v1-update-storage-config) |
| Compute | Read | [Get a worker](/docs/reference/api/v2-get-a-worker) |
| | | [List all workers](/docs/reference/api/v2-list-all-workers) |
| | Read-write | [Create worker upload](/docs/reference/api/v2-create-worker-upload) |
| | | [Delete a worker](/docs/reference/api/v2-delete-a-worker) |
| | | [Deploy a worker](/docs/reference/api/v2-deploy-a-worker) |
| Compute | Read | [Get a compute instance](/docs/reference/api/v2-get-a-compute-instance) |
| | | [List all compute instances](/docs/reference/api/v2-list-all-compute-instances) |
| | Read-write | [Create compute instance upload](/docs/reference/api/v2-create-compute-instance-upload) |
| | | [Delete a compute instance](/docs/reference/api/v2-delete-a-compute-instance) |
| | | [Deploy a compute instance](/docs/reference/api/v2-deploy-a-compute-instance) |
| **Infrastructure and delivery** | | |
| Development Branches | Read | [Get a branch](/docs/reference/api/v1-get-a-branch) |
| | | [Get a branch config](/docs/reference/api/v1-get-a-branch-config) |
apps/docs/spec/api_v1_openapi.json
+290 -158
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/api_v2_openapi.json
+1205 -2459
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/common-api-sections.json
+122 -92
View File
@@ -234,6 +234,42 @@
}
]
},
{
"type": "category",
"title": "Compute",
"items": [
{
"id": "v2-create-compute-instance-upload",
"title": "Create compute instance upload",
"slug": "v2-create-compute-instance-upload",
"type": "operation"
},
{
"id": "v2-delete-a-compute-instance",
"title": "Delete a compute instance",
"slug": "v2-delete-a-compute-instance",
"type": "operation"
},
{
"id": "v2-deploy-a-compute-instance",
"title": "Deploy a compute instance",
"slug": "v2-deploy-a-compute-instance",
"type": "operation"
},
{
"id": "v2-get-a-compute-instance",
"title": "Get a compute instance",
"slug": "v2-get-a-compute-instance",
"type": "operation"
},
{
"id": "v2-list-all-compute-instances",
"title": "List all compute instances",
"slug": "v2-list-all-compute-instances",
"type": "operation"
}
]
},
{
"type": "category",
"title": "Database",
@@ -749,63 +785,63 @@
"title": "Organization webhooks",
"items": [
{
"id": "v2-organizations-slug-webhooks-deliveries-id-get",
"title": "Organizations slug webhooks deliveries id get",
"slug": "v2-organizations-slug-webhooks-deliveries-id-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-deliveries-id-retry-post",
"title": "Organizations slug webhooks deliveries id retry post",
"slug": "v2-organizations-slug-webhooks-deliveries-id-retry-post",
"id": "v2-organizations-slug-webhooks-endpoints-post",
"title": "Create endpoint",
"slug": "v2-organizations-slug-webhooks-endpoints-post",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-delete",
"title": "Organizations slug webhooks endpoints delete",
"title": "Delete all endpoints",
"slug": "v2-organizations-slug-webhooks-endpoints-delete",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-get",
"title": "Organizations slug webhooks endpoints get",
"slug": "v2-organizations-slug-webhooks-endpoints-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-id-delete",
"title": "Organizations slug webhooks endpoints id delete",
"title": "Delete endpoint",
"slug": "v2-organizations-slug-webhooks-endpoints-id-delete",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-id-deliveries-get",
"title": "Organizations slug webhooks endpoints id deliveries get",
"slug": "v2-organizations-slug-webhooks-endpoints-id-deliveries-get",
"id": "v2-organizations-slug-webhooks-deliveries-id-get",
"title": "Get delivery",
"slug": "v2-organizations-slug-webhooks-deliveries-id-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-id-get",
"title": "Organizations slug webhooks endpoints id get",
"title": "Get endpoint",
"slug": "v2-organizations-slug-webhooks-endpoints-id-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-id-patch",
"title": "Organizations slug webhooks endpoints id patch",
"slug": "v2-organizations-slug-webhooks-endpoints-id-patch",
"id": "v2-organizations-slug-webhooks-endpoints-id-deliveries-get",
"title": "List deliveries",
"slug": "v2-organizations-slug-webhooks-endpoints-id-deliveries-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-get",
"title": "List endpoints",
"slug": "v2-organizations-slug-webhooks-endpoints-get",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-deliveries-id-retry-post",
"title": "Retry delivery",
"slug": "v2-organizations-slug-webhooks-deliveries-id-retry-post",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-id-test-post",
"title": "Organizations slug webhooks endpoints id test post",
"title": "Send test event",
"slug": "v2-organizations-slug-webhooks-endpoints-id-test-post",
"type": "operation"
},
{
"id": "v2-organizations-slug-webhooks-endpoints-post",
"title": "Organizations slug webhooks endpoints post",
"slug": "v2-organizations-slug-webhooks-endpoints-post",
"id": "v2-organizations-slug-webhooks-endpoints-id-patch",
"title": "Update endpoint",
"slug": "v2-organizations-slug-webhooks-endpoints-id-patch",
"type": "operation"
}
]
@@ -911,63 +947,63 @@
"title": "Project webhooks",
"items": [
{
"id": "v2-projects-ref-webhooks-deliveries-id-get",
"title": "Projects ref webhooks deliveries id get",
"slug": "v2-projects-ref-webhooks-deliveries-id-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-deliveries-id-retry-post",
"title": "Projects ref webhooks deliveries id retry post",
"slug": "v2-projects-ref-webhooks-deliveries-id-retry-post",
"id": "v2-projects-ref-webhooks-endpoints-post",
"title": "Create endpoint",
"slug": "v2-projects-ref-webhooks-endpoints-post",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-delete",
"title": "Projects ref webhooks endpoints delete",
"title": "Delete all endpoints",
"slug": "v2-projects-ref-webhooks-endpoints-delete",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-get",
"title": "Projects ref webhooks endpoints get",
"slug": "v2-projects-ref-webhooks-endpoints-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-id-delete",
"title": "Projects ref webhooks endpoints id delete",
"title": "Delete endpoint",
"slug": "v2-projects-ref-webhooks-endpoints-id-delete",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-id-deliveries-get",
"title": "Projects ref webhooks endpoints id deliveries get",
"slug": "v2-projects-ref-webhooks-endpoints-id-deliveries-get",
"id": "v2-projects-ref-webhooks-deliveries-id-get",
"title": "Get delivery",
"slug": "v2-projects-ref-webhooks-deliveries-id-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-id-get",
"title": "Projects ref webhooks endpoints id get",
"title": "Get endpoint",
"slug": "v2-projects-ref-webhooks-endpoints-id-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-id-patch",
"title": "Projects ref webhooks endpoints id patch",
"slug": "v2-projects-ref-webhooks-endpoints-id-patch",
"id": "v2-projects-ref-webhooks-endpoints-id-deliveries-get",
"title": "List deliveries",
"slug": "v2-projects-ref-webhooks-endpoints-id-deliveries-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-get",
"title": "List endpoints",
"slug": "v2-projects-ref-webhooks-endpoints-get",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-deliveries-id-retry-post",
"title": "Retry delivery",
"slug": "v2-projects-ref-webhooks-deliveries-id-retry-post",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-id-test-post",
"title": "Projects ref webhooks endpoints id test post",
"title": "Send test event",
"slug": "v2-projects-ref-webhooks-endpoints-id-test-post",
"type": "operation"
},
{
"id": "v2-projects-ref-webhooks-endpoints-post",
"title": "Projects ref webhooks endpoints post",
"slug": "v2-projects-ref-webhooks-endpoints-post",
"id": "v2-projects-ref-webhooks-endpoints-id-patch",
"title": "Update endpoint",
"slug": "v2-projects-ref-webhooks-endpoints-id-patch",
"type": "operation"
}
]
@@ -988,6 +1024,12 @@
"slug": "v1-create-a-project",
"type": "operation"
},
{
"id": "v2-create-notebook",
"title": "Create notebook",
"slug": "v2-create-notebook",
"type": "operation"
},
{
"id": "v2-create-private-link-association",
"title": "Create private link association",
@@ -1006,6 +1048,12 @@
"slug": "v1-delete-network-bans",
"type": "operation"
},
{
"id": "v2-delete-notebook",
"title": "Delete notebook",
"slug": "v2-delete-notebook",
"type": "operation"
},
{
"id": "v2-delete-private-link-association",
"title": "Delete private link association",
@@ -1048,6 +1096,12 @@
"slug": "v1-get-network-restrictions",
"type": "operation"
},
{
"id": "v2-get-notebook",
"title": "Get notebook",
"slug": "v2-get-notebook",
"type": "operation"
},
{
"id": "v1-get-postgres-upgrade-eligibility",
"title": "Get postgres upgrade eligibility",
@@ -1108,6 +1162,12 @@
"slug": "v1-list-available-restore-versions",
"type": "operation"
},
{
"id": "v2-list-notebooks",
"title": "List notebooks",
"slug": "v2-list-notebooks",
"type": "operation"
},
{
"id": "v2-list-private-link-associations",
"title": "List private link associations",
@@ -1168,6 +1228,12 @@
"slug": "v1-update-network-restrictions",
"type": "operation"
},
{
"id": "v2-update-notebook",
"title": "Update notebook",
"slug": "v2-update-notebook",
"type": "operation"
},
{
"id": "v1-upgrade-postgres-version",
"title": "Upgrade postgres version",
@@ -1319,41 +1385,5 @@
"type": "operation"
}
]
},
{
"type": "category",
"title": "Workers",
"items": [
{
"id": "v2-create-worker-upload",
"title": "Create worker upload",
"slug": "v2-create-worker-upload",
"type": "operation"
},
{
"id": "v2-delete-a-worker",
"title": "Delete a worker",
"slug": "v2-delete-a-worker",
"type": "operation"
},
{
"id": "v2-deploy-a-worker",
"title": "Deploy a worker",
"slug": "v2-deploy-a-worker",
"type": "operation"
},
{
"id": "v2-get-a-worker",
"title": "Get a worker",
"slug": "v2-get-a-worker",
"type": "operation"
},
{
"id": "v2-list-all-workers",
"title": "List all workers",
"slug": "v2-list-all-workers",
"type": "operation"
}
]
}
]
apps/docs/spec/mcp_tools_permissions.json
+1
View File
@@ -26,6 +26,7 @@
"list_edge_functions": [["edge_functions_read"]],
"get_edge_function": [["edge_functions_read"]],
"deploy_edge_function": [["edge_functions_write"]],
"create_edge_function_secret": [["edge_functions_secrets_write", "edge_functions_secrets_read"]],
"get_storage_config": [["storage_config_read"]],
"update_storage_config": [["storage_config_write"]],
"list_storage_buckets": [["storage_read"]],
apps/docs/spec/transforms/api_v1_openapi_deparsed.json
+322 -132
View File
File diff suppressed because it is too large. Load diff
apps/docs/spec/transforms/api_v2_openapi_deparsed.json
+1622 -3526
View File
File diff suppressed because it is too large. Load diff