From e54394cfd8771b961bbad28ef2dee66222964701 Mon Sep 17 00:00:00 2001 From: "supabase-supabase-autofixer[bot]" <248690971+supabase-supabase-autofixer[bot]@users.noreply.github.com> Date: Wed, 30 Sep 2026 18:34:09 +0200 Subject: [PATCH] feat: update mgmt api docs (#49743) 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> --- .../access-control/scoped_pat_mcp_tools.mdx | 71 +- .../access-control/scoped_pat_permissions.mdx | 15 +- apps/docs/spec/api_v1_openapi.json | 448 +- apps/docs/spec/api_v2_openapi.json | 3664 ++++-------- apps/docs/spec/common-api-sections.json | 214 +- apps/docs/spec/mcp_tools_permissions.json | 1 + .../transforms/api_v1_openapi_deparsed.json | 454 +- .../transforms/api_v2_openapi_deparsed.json | 5148 ++++++----------- 8 files changed, 3608 insertions(+), 6407 deletions(-) diff --git a/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx b/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx index acc7a113486..8b92471e540 100644 --- a/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx +++ b/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx @@ -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) | diff --git a/apps/docs/content/_partials/access-control/scoped_pat_permissions.mdx b/apps/docs/content/_partials/access-control/scoped_pat_permissions.mdx index 6a36e4ef6e8..49e0a906a08 100644 --- a/apps/docs/content/_partials/access-control/scoped_pat_permissions.mdx +++ b/apps/docs/content/_partials/access-control/scoped_pat_permissions.mdx @@ -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) | diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json index f283a252e38..bf0ce8ff0e5 100644 --- a/apps/docs/spec/api_v1_openapi.json +++ b/apps/docs/spec/api_v1_openapi.json @@ -408,7 +408,7 @@ }, "/v1/branches/{branch_id_or_ref}/diff": { "get": { - "description": "Diffs the specified database branch", + "description": "Diffs the specified database branch\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-diff-a-branch", "parameters": [ { @@ -461,12 +461,16 @@ "500": { "description": "Failed to diff database branch" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Diffs a database branch", + "summary": "Diffs a database branch", "tags": ["Environments"], - "x-badges": [{ "name": "OAuth scope: environment:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: environment:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["branching_development_write"], ["branching_production_write"]], - "x-oauth-scope": "environment:write" + "x-oauth-scope": "environment:write", + "x-scalar-stability": "experimental" } }, "/v1/projects": { @@ -531,6 +535,7 @@ }, "/v1/projects/available-regions": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-available-regions", "parameters": [ { @@ -593,11 +598,15 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets the list of available regions that can be used for a new project", + "summary": "Gets the list of available regions that can be used for a new project", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: organizations:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: organizations:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra"], - "x-oauth-scope": "organizations:read" + "x-oauth-scope": "organizations:read", + "x-scalar-stability": "experimental" } }, "/v1/organizations": { @@ -664,6 +673,7 @@ }, "/v1/oauth/authorize": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-authorize-user", "parameters": [ { @@ -758,14 +768,16 @@ "403": { "description": "Forbidden action" }, "429": { "description": "Rate limit exceeded" } }, - "summary": "[Beta] Authorize user through oauth", + "summary": "Authorize user through oauth", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [{ "name": "Beta", "position": "before" }], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/token": { "post": { - "description": "Supports `authorization_code`, `refresh_token`, and `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only.", + "description": "Supports `authorization_code`, `refresh_token`, and `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-exchange-oauth-token", "parameters": [], "requestBody": { @@ -789,13 +801,16 @@ "403": { "description": "Forbidden action" }, "429": { "description": "Rate limit exceeded" } }, - "summary": "[Beta] Exchange auth code for user's access and refresh token", + "summary": "Exchange auth code for user's access and refresh token", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [{ "name": "Beta", "position": "before" }], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/revoke": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-revoke-token", "parameters": [], "requestBody": { @@ -812,9 +827,11 @@ "403": { "description": "Forbidden action" }, "429": { "description": "Rate limit exceeded" } }, - "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", + "summary": "Revoke oauth app authorization and it's corresponding tokens", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [{ "name": "Beta", "position": "before" }], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/authorize/project-claim": { @@ -1817,6 +1834,7 @@ }, "/v1/projects/{ref}/custom-hostname": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-hostname-config", "parameters": [ { @@ -1848,14 +1866,19 @@ "500": { "description": "Failed to retrieve project's custom hostname config" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets project's custom hostname config", + "summary": "Gets project's custom hostname config", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_read"]], - "x-oauth-scope": "domains:read" + "x-oauth-scope": "domains:read", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-Delete hostname config", "parameters": [ { @@ -1887,16 +1910,21 @@ "500": { "description": "Failed to delete project custom hostname configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Deletes a project's custom hostname configuration", + "summary": "Deletes a project's custom hostname configuration", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/initialize": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-hostname-config", "parameters": [ { @@ -1936,16 +1964,21 @@ "500": { "description": "Failed to update project custom hostname configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Updates project's custom hostname configuration", + "summary": "Updates project's custom hostname configuration", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/reverify": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-verify-dns-config", "parameters": [ { @@ -1977,16 +2010,21 @@ "500": { "description": "Failed to verify project custom hostname configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", + "summary": "Attempts to verify the DNS configuration for project's custom hostname configuration", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/activate": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-activate-custom-hostname", "parameters": [ { @@ -2018,16 +2056,21 @@ "500": { "description": "Failed to activate project custom hostname configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Activates a custom hostname for a project.", + "summary": "Activates a custom hostname for a project.", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/jit-access": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-jit-access-config", "parameters": [ { @@ -2087,14 +2130,19 @@ "500": { "description": "Failed to retrieve project's temporary access configuration." } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Get project's temporary access configuration.", + "summary": "Get project's temporary access configuration.", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["security", "control-plane"], "x-fga-permissions": [["project_admin_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-jit-access-config", "parameters": [ { @@ -2162,16 +2210,21 @@ "500": { "description": "Failed to update project's temporary access configuration." } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Update project's temporary access configuration.", + "summary": "Update project's temporary access configuration.", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["security", "control-plane"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans/retrieve": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-list-all-network-bans", "parameters": [ { @@ -2203,16 +2256,21 @@ "500": { "description": "Failed to retrieve project's network bans" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets project's network bans", + "summary": "Gets project's network bans", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans/retrieve/enriched": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-list-all-network-bans-enriched", "parameters": [ { @@ -2244,16 +2302,21 @@ "500": { "description": "Failed to retrieve project's enriched network bans" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", + "summary": "Gets project's network bans with additional information about which databases they affect", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans": { "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-delete-network-bans", "parameters": [ { @@ -2286,16 +2349,21 @@ "500": { "description": "Failed to remove network bans." } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Remove network bans.", + "summary": "Remove network bans.", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-restrictions": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-network-restrictions", "parameters": [ { @@ -2327,14 +2395,19 @@ "500": { "description": "Failed to retrieve project's network restrictions" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets project's network restrictions", + "summary": "Gets project's network restrictions", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" }, "patch": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Alpha** stage.", "operationId": "v1-patch-network-restrictions", "parameters": [ { @@ -2374,16 +2447,21 @@ "500": { "description": "Failed to update project network restrictions" } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Updates project's network restrictions by adding or removing CIDRs", + "summary": "Updates project's network restrictions by adding or removing CIDRs", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:write", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-restrictions/apply": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-network-restrictions", "parameters": [ { @@ -2423,16 +2501,21 @@ "500": { "description": "Failed to update project network restrictions" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Updates project's network restrictions", + "summary": "Updates project's network restrictions", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/pgsodium": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-pgsodium-config", "parameters": [ { @@ -2464,14 +2547,19 @@ "500": { "description": "Failed to retrieve project's pgsodium config" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets project's pgsodium config", + "summary": "Gets project's pgsodium config", "tags": ["Secrets"], - "x-badges": [{ "name": "OAuth scope: secrets:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: secrets:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "secrets:read" + "x-oauth-scope": "secrets:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-pgsodium-config", "parameters": [ { @@ -2511,12 +2599,16 @@ "500": { "description": "Failed to update project's pgsodium config" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", + "summary": "Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", "tags": ["Secrets"], - "x-badges": [{ "name": "OAuth scope: secrets:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: secrets:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "secrets:write" + "x-oauth-scope": "secrets:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/postgrest": { @@ -2861,6 +2953,7 @@ }, "/v1/projects/{ref}/ssl-enforcement": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-ssl-enforcement-config", "parameters": [ { @@ -2892,14 +2985,19 @@ "500": { "description": "Failed to retrieve project's SSL enforcement config" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Get project's SSL enforcement configuration.", + "summary": "Get project's SSL enforcement configuration.", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_ssl_config_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-ssl-enforcement-config", "parameters": [ { @@ -2939,12 +3037,16 @@ "500": { "description": "Failed to update project's SSL enforcement configuration." } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Update project's SSL enforcement configuration.", + "summary": "Update project's SSL enforcement configuration.", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_ssl_config_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/types/typescript": { @@ -2997,6 +3099,7 @@ }, "/v1/projects/{ref}/vanity-subdomain": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-vanity-subdomain-config", "parameters": [ { @@ -3034,18 +3137,21 @@ "500": { "description": "Failed to get project vanity subdomain configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets current vanity subdomain config", + "summary": "Gets current vanity subdomain config", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ { "name": "OAuth scope: domains:read", "position": "after" }, + { "name": "Beta", "position": "before" }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_read"]], - "x-oauth-scope": "domains:read" + "x-oauth-scope": "domains:read", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-deactivate-vanity-subdomain-config", "parameters": [ { @@ -3070,16 +3176,21 @@ "500": { "description": "Failed to delete project vanity subdomain configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Deletes a project's vanity subdomain configuration", + "summary": "Deletes a project's vanity subdomain configuration", "tags": ["Domains"], - "x-badges": [{ "name": "OAuth scope: domains:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/vanity-subdomain/check-availability": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-check-vanity-subdomain-availability", "parameters": [ { @@ -3123,20 +3234,23 @@ "500": { "description": "Failed to check project vanity subdomain configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Checks vanity subdomain availability", + "summary": "Checks vanity subdomain availability", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/vanity-subdomain/activate": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-activate-vanity-subdomain-config", "parameters": [ { @@ -3180,20 +3294,23 @@ "500": { "description": "Failed to activate project vanity subdomain configuration" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Activates a vanity subdomain for a project.", + "summary": "Activates a vanity subdomain for a project.", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" }, + { "name": "Beta", "position": "before" }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-upgrade-postgres-version", "parameters": [ { @@ -3231,16 +3348,21 @@ "500": { "description": "Failed to initiate project upgrade" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Upgrades the project's Postgres version", + "summary": "Upgrades the project's Postgres version", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_write", "database_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade/eligibility": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-postgres-upgrade-eligibility", "parameters": [ { @@ -3274,16 +3396,21 @@ "500": { "description": "Failed to determine project upgrade eligibility" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Returns the project's eligibility for upgrades", + "summary": "Returns the project's eligibility for upgrades", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_read", "database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade/status": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-postgres-upgrade-status", "parameters": [ { @@ -3321,12 +3448,16 @@ "500": { "description": "Failed to retrieve project upgrade status" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Gets the latest status of the project's upgrade", + "summary": "Gets the latest status of the project's upgrade", "tags": ["Projects"], - "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: projects:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_read", "database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/readonly": { @@ -3406,6 +3537,7 @@ }, "/v1/projects/{ref}/read-replicas/setup": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-setup-a-read-replica", "parameters": [ { @@ -3444,16 +3576,21 @@ "500": { "description": "Failed to set up read replica" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Set up a read replica", + "summary": "Set up a read replica", "tags": ["Database"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], - "x-badges": [{ "name": "Only available on Pro, Team, Enterprise", "position": "before" }], + "x-badges": [ + { "name": "Beta", "position": "before" }, + { "name": "Only available on Pro, Team, Enterprise", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], - "x-fga-permissions": [["infra_read_replicas_write"]] + "x-fga-permissions": [["infra_read_replicas_write"]], + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/read-replicas/remove": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-remove-a-read-replica", "parameters": [ { @@ -3486,10 +3623,12 @@ "500": { "description": "Failed to remove read replica" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Remove a read replica", + "summary": "Remove a read replica", "tags": ["Database"], + "x-badges": [{ "name": "Beta", "position": "before" }], "x-endpoint-owners": ["control-plane", "infra"], - "x-fga-permissions": [["infra_read_replicas_write"]] + "x-fga-permissions": [["infra_read_replicas_write"]], + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/health": { @@ -4600,7 +4739,6 @@ }, "/v1/projects/{ref}/advisors/performance": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-performance-advisors", "parameters": [ @@ -4637,12 +4775,12 @@ "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["advisors_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/advisors/security": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-security-advisors", "parameters": [ @@ -4685,13 +4823,14 @@ "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["advisors_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/analytics/endpoints/logs.all": { "get": { "deprecated": true, - "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](https://supabase.com/docs/guides/monitoring-and-debugging/logs#logs-explorer) for all available sources.\n", + "description": "This endpoint has been removed and always responds with `410 Gone`. Use `GET /v1/projects/{ref}/analytics/endpoints/logs` instead. See the [migration guide](https://supabase.com/changelog/48235-migration-of-supabase-management-api-logs-all-analytics-endpoint-to-logs-endpoint).", "operationId": "v1-get-project-logs-all", "parameters": [ { @@ -4706,52 +4845,12 @@ "example": "abcdefghijklmnopqrst", "type": "string" } - }, - { - "name": "sql", - "required": false, - "in": "query", - "description": "Custom SQL query to execute on the logs. See [querying logs](https://supabase.com/docs/guides/monitoring-and-debugging/logs#querying-with-the-logs-explorer) for more details.", - "schema": { - "example": "select event_message from edge_logs limit 10", - "type": "string" - } - }, - { - "name": "iso_timestamp_start", - "required": false, - "in": "query", - "schema": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "example": "2025-03-01T00:00:00Z", - "type": "string" - } - }, - { - "name": "iso_timestamp_end", - "required": false, - "in": "query", - "schema": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "example": "2025-03-01T23:59:59Z", - "type": "string" - } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/AnalyticsResponse_Output" } - } - } - }, "401": { "description": "Unauthorized" }, - "402": { "description": "Usage exceeded. Enable additional usage to continue querying" }, "403": { "description": "Forbidden action" }, + "410": { "description": "This endpoint has been removed" }, "429": { "description": "Rate limit exceeded" } }, "security": [{ "bearer": [] }], @@ -5029,6 +5128,7 @@ }, "/v1/projects/{ref}/cli/login-role": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-create-login-role", "parameters": [ { @@ -5066,14 +5166,19 @@ "500": { "description": "Failed to create login role" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Create a login role for CLI with temporary password", + "summary": "Create a login role for CLI with temporary password", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-delete-login-roles", "parameters": [ { @@ -5105,12 +5210,16 @@ "500": { "description": "Failed to delete login roles" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Delete existing login roles used by CLI", + "summary": "Delete existing login roles used by CLI", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/migrations": { @@ -5382,6 +5491,7 @@ }, "/v1/projects/{ref}/database/query": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-run-a-query", "parameters": [ { @@ -5412,17 +5522,21 @@ "500": { "description": "Failed to run sql query" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Run sql query", + "summary": "Run sql query", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"], ["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/query/read-only": { "post": { - "description": "All entity references must be schema qualified.", + "description": "All entity references must be schema qualified.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-read-only-query", "parameters": [ { @@ -5453,16 +5567,21 @@ "500": { "description": "Failed to run read-only sql query" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Run a sql query as supabase_read_only_user", + "summary": "Run a sql query as supabase_read_only_user", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:read", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/webhooks/enable": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-enable-database-webhook", "parameters": [ { @@ -5487,17 +5606,20 @@ "500": { "description": "Failed to enable Database Webhooks on the project" } }, "security": [{ "bearer": [] }], - "summary": "[Beta] Enables Database Webhooks on the project", + "summary": "Enables Database Webhooks on the project", "tags": ["Database"], - "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-badges": [ + { "name": "OAuth scope: database:write", "position": "after" }, + { "name": "Beta", "position": "before" } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_webhooks_config_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/context": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-database-metadata", "parameters": [ @@ -5534,7 +5656,8 @@ "x-badges": [{ "name": "OAuth scope: projects:read", "position": "after" }], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/password": { @@ -8841,7 +8964,7 @@ "schema_version": { "type": "string" }, "sql": { "type": "string" } }, - "required": ["schema_version", "sql"] + "required": ["sql"] } }, "required": [ @@ -12070,6 +12193,7 @@ "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, + "act": { "type": "string" }, "user_role": { "type": "object", "properties": { @@ -12113,7 +12237,7 @@ "required": ["role"] } }, - "required": ["user_id", "user_role"] + "required": ["user_role"] }, "JitListAccessResponse_Output": { "type": "object", @@ -13282,7 +13406,7 @@ "max_concurrent_users": { "type": "integer", "minimum": 1, - "maximum": 50000, + "maximum": 300000, "description": "Sets maximum number of concurrent users rate limit", "nullable": true }, @@ -13333,7 +13457,14 @@ "description": "Disables the Realtime service for this project when true. Set to false to re-enable it.", "nullable": true }, - "presence_enabled": { "type": "boolean", "description": "Whether to enable presence" } + "presence_enabled": { "type": "boolean", "description": "Whether to enable presence" }, + "admin_suspended_at": { + "type": "string", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "description": "If set, the Realtime service has been suspended by an admin.", + "nullable": true + } }, "required": [ "private_only", @@ -13347,7 +13478,8 @@ "max_presence_events_per_second", "max_payload_size_in_kb", "suspend", - "presence_enabled" + "presence_enabled", + "admin_suspended_at" ] }, "UpdateRealtimeConfigBody": { @@ -13372,7 +13504,7 @@ "max_concurrent_users": { "type": "integer", "minimum": 1, - "maximum": 50000, + "maximum": 300000, "description": "Sets maximum number of concurrent users rate limit" }, "max_events_per_second": { diff --git a/apps/docs/spec/api_v2_openapi.json b/apps/docs/spec/api_v2_openapi.json index c7ade37d0ad..fdac7fb7882 100644 --- a/apps/docs/spec/api_v2_openapi.json +++ b/apps/docs/spec/api_v2_openapi.json @@ -427,7 +427,7 @@ }, "/v2/projects/{ref}/config": { "get": { - "description": "Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. `storage` is read live from the storage service; the rest come from this platform's own records.", + "description": "Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. `storage` is read live from the storage service; the rest come from this platform's own records.\n\nThis endpoint is currently in its **Alpha** stage.", "operationId": "v2-get-project-config", "parameters": [ { @@ -473,8 +473,9 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Get a project's service configuration", + "summary": "Get a project's service configuration", "tags": ["Projects"], + "x-badges": [{ "name": "Alpha", "position": "before" }], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [ [ @@ -487,7 +488,412 @@ "realtime_config_read", "storage_config_read" ] - ] + ], + "x-scalar-stability": "experimental" + } + }, + "/v2/projects/{ref}/notebooks": { + "get": { + "description": "Returns a cursor-paginated list of the project notebooks. Notebook bodies are omitted — read a single notebook to get its cells.", + "operationId": "v2-list-notebooks", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "schema": { + "properties": { + "size": { "type": "integer", "minimum": 1, "maximum": 100 }, + "after": { "type": "string", "minLength": 1 }, + "before": { "type": "string", "minLength": 1 } + }, + "type": "object" + }, + "style": "deepObject" + }, + { + "name": "filter", + "required": false, + "in": "query", + "schema": { + "properties": { "name": { "type": "string", "minLength": 1 } }, + "type": "object" + }, + "style": "deepObject" + }, + { + "name": "sort", + "required": false, + "in": "query", + "schema": { "type": "string", "enum": ["name", "-name", "inserted_at", "-inserted_at"] } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2ListNotebooksResponse_Output" } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "500": { + "description": "Failed to retrieve project's notebooks", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + } + }, + "security": [{ "bearer": [] }], + "summary": "List notebooks of a project", + "tags": ["Projects"], + "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_read"]], + "x-oauth-scope": "database:read" + }, + "post": { + "description": "Creates a notebook shared with everyone who has access to the project. Cell ids are assigned by the server and returned in the response.", + "operationId": "v2-create-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2CreateNotebookRequest" } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2NotebookResponse_Output" } + } + } + }, + "400": { + "description": "The request repeats a cell id", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "500": { + "description": "Failed to create notebook", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + } + }, + "security": [{ "bearer": [] }], + "summary": "Create a notebook", + "tags": ["Projects"], + "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" + } + }, + "/v2/projects/{ref}/notebooks/{id}": { + "get": { + "operationId": "v2-get-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2NotebookResponse_Output" } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "500": { + "description": "Failed to retrieve notebook", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + } + }, + "security": [{ "bearer": [] }], + "summary": "Get a notebook", + "tags": ["Projects"], + "x-badges": [{ "name": "OAuth scope: database:read", "position": "after" }], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_read"]], + "x-oauth-scope": "database:read" + }, + "patch": { + "description": "Updates the attributes provided and leaves the rest untouched. Sending `content` replaces the whole notebook body.", + "operationId": "v2-update-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2UpdateNotebookRequest" } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/V2NotebookResponse_Output" } + } + } + }, + "400": { + "description": "The request references a cell that does not exist on this notebook, or repeats a cell id", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "500": { + "description": "Failed to update notebook", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + } + }, + "security": [{ "bearer": [] }], + "summary": "Update a notebook", + "tags": ["Projects"], + "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" + }, + "delete": { + "operationId": "v2-delete-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "responses": { + "204": { "description": "" }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + }, + "500": { + "description": "Failed to delete notebook", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } } + } + } + }, + "security": [{ "bearer": [] }], + "summary": "Delete a notebook", + "tags": ["Projects"], + "x-badges": [{ "name": "OAuth scope: database:write", "position": "after" }], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" } }, "/v2/projects/{ref}/transfers/previews": { @@ -867,10 +1273,10 @@ "x-fga-permissions": [["project_admin_write"]] } }, - "/v2/projects/{ref}/workers": { + "/v2/projects/{ref}/compute": { "get": { - "description": "Returns all workers you've previously deployed to the specified project.", - "operationId": "v2-list-all-workers", + "description": "Returns all compute instances you've previously deployed to the specified project.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-list-all-compute-instances", "parameters": [ { "name": "ref", @@ -891,7 +1297,7 @@ "description": "", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V2ListWorkersResponse_Output" } + "schema": { "$ref": "#/components/schemas/V2ListComputeInstancesResponse_Output" } } } }, @@ -915,18 +1321,22 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] List all workers", - "tags": ["Workers"], - "x-badges": [{ "name": "OAuth scope: edge_functions:read", "position": "after" }], + "summary": "List all compute instances", + "tags": ["Compute"], + "x-badges": [ + { "name": "OAuth scope: edge_functions:read", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_read"]], - "x-oauth-scope": "edge_functions:read" + "x-oauth-scope": "edge_functions:read", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}": { + "/v2/projects/{ref}/compute/{name}": { "get": { - "description": "Returns a worker along with its instance tally. Poll this after a deploy until `build_state` leaves `building`.", - "operationId": "v2-get-a-worker", + "description": "Returns a compute instance along with the counts of its running instances. Poll this after a deploy until `build_state` leaves `building`.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-get-a-compute-instance", "parameters": [ { "name": "ref", @@ -957,7 +1367,7 @@ "description": "", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V2WorkerResponse_Output" } + "schema": { "$ref": "#/components/schemas/V2ComputeInstanceResponse_Output" } } } }, @@ -981,16 +1391,20 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Retrieve a worker", - "tags": ["Workers"], - "x-badges": [{ "name": "OAuth scope: edge_functions:read", "position": "after" }], + "summary": "Retrieve a compute instance", + "tags": ["Compute"], + "x-badges": [ + { "name": "OAuth scope: edge_functions:read", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_read"]], - "x-oauth-scope": "edge_functions:read" + "x-oauth-scope": "edge_functions:read", + "x-scalar-stability": "experimental" }, "delete": { - "description": "Tombstones the worker. Its instances and image are torn down asynchronously.", - "operationId": "v2-delete-a-worker", + "description": "Tombstones the compute instance. Its running instances and image are torn down asynchronously.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-delete-a-compute-instance", "parameters": [ { "name": "ref", @@ -1038,18 +1452,22 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Delete a worker", - "tags": ["Workers"], - "x-badges": [{ "name": "OAuth scope: edge_functions:write", "position": "after" }], + "summary": "Delete a compute instance", + "tags": ["Compute"], + "x-badges": [ + { "name": "OAuth scope: edge_functions:write", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}/uploads": { + "/v2/projects/{ref}/compute/{name}/uploads": { "post": { - "description": "PUT the `.tar.gz` build context to the returned `url` before `expires_at`, then deploy with the upload id as `context_upload_id`. The bytes go straight to storage — no management API request carries them.", - "operationId": "v2-create-worker-upload", + "description": "PUT the `.tar.gz` build context to the returned `url` before `expires_at`, then deploy with the upload id as `context_upload_id`. The bytes go straight to storage — no management API request carries them.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-create-compute-instance-upload", "parameters": [ { "name": "ref", @@ -1080,7 +1498,7 @@ "description": "", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V2WorkerUploadResponse_Output" } + "schema": { "$ref": "#/components/schemas/V2ComputeInstanceUploadResponse_Output" } } } }, @@ -1104,18 +1522,22 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Mint a presigned slot for a build-context upload", - "tags": ["Workers"], - "x-badges": [{ "name": "OAuth scope: edge_functions:write", "position": "after" }], + "summary": "Mint a presigned slot for a build-context upload", + "tags": ["Compute"], + "x-badges": [ + { "name": "OAuth scope: edge_functions:write", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}/deploy": { + "/v2/projects/{ref}/compute/{name}/deploy": { "post": { - "description": "Creates the worker if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the worker reaches `build_state` `active` or `failed` later.", - "operationId": "v2-deploy-a-worker", + "description": "Creates the compute instance if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the compute instance reaches `build_state` `active` or `failed` later.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-deploy-a-compute-instance", "parameters": [ { "name": "ref", @@ -1145,7 +1567,7 @@ "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V2DeployWorkerRequest" } + "schema": { "$ref": "#/components/schemas/V2DeployComputeInstanceRequest" } } } }, @@ -1154,7 +1576,7 @@ "description": "", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/V2WorkerResponse_Output" } + "schema": { "$ref": "#/components/schemas/V2ComputeInstanceResponse_Output" } } } }, @@ -1178,12 +1600,16 @@ } }, "security": [{ "bearer": [] }], - "summary": "[Alpha] Deploy a worker", - "tags": ["Workers"], - "x-badges": [{ "name": "OAuth scope: edge_functions:write", "position": "after" }], + "summary": "Deploy a compute instance", + "tags": ["Compute"], + "x-badges": [ + { "name": "OAuth scope: edge_functions:write", "position": "after" }, + { "name": "Alpha", "position": "before" } + ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, "/v2/organizations/{slug}/members": { @@ -1940,128 +2366,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -2575,128 +2879,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -3318,128 +3500,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -3966,128 +4026,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -4675,128 +4613,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -5484,128 +5300,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -6223,128 +5917,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -6929,92 +6501,6 @@ }, "required": ["code", "message"], "title": "EndpointTestWrongEventType" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" } ] } @@ -7040,22 +6526,6 @@ "description": "Only event types that the endpoint is subscribed to can be specified." } } - }, - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } } } } @@ -7785,128 +7255,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -8391,128 +7739,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -9133,128 +8359,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -9766,128 +8870,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -10507,128 +9489,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -11153,128 +10013,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -11860,128 +10598,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -12667,128 +11283,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -13404,128 +11898,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -14108,92 +12480,6 @@ }, "required": ["code", "message"], "title": "EndpointTestWrongEventType" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" } ] } @@ -14219,22 +12505,6 @@ "description": "Only event types that the endpoint is subscribed to can be specified." } } - }, - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } } } } @@ -14962,128 +13232,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -15566,128 +13714,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_slug" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { "type": "string" }, - "code": { "type": "string", "const": "bad_request.invalid_ref" }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { "type": "string" }, - "links": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { "type": "string" }, - "rel": { "type": "string" }, - "title": { "type": "string" }, - "type": { "type": "string" }, - "describedby": { "type": "string" }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { "type": "string" }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { "$ref": "#/components/schemas/APIErrorObject" } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { "APIErrorObject": { "$ref": "#/components/schemas/APIErrorObject" } } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -17563,6 +15589,708 @@ }, "required": ["data"] }, + "V2ListNotebooksResponse_Output": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { "type": "string", "description": "Resource type.", "enum": ["notebook"] }, + "id": { "type": "string" }, + "attributes": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "favorite": { "type": "boolean" }, + "inserted_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "owner": { + "type": "object", + "properties": { + "id": { "type": "number" }, + "username": { "type": "string" } + }, + "required": ["id", "username"], + "description": "User who created the notebook.", + "nullable": true + }, + "updated_by": { + "type": "object", + "properties": { + "id": { "type": "number" }, + "username": { "type": "string" } + }, + "required": ["id", "username"], + "description": "User who last wrote to the notebook.", + "nullable": true + } + }, + "required": [ + "name", + "description", + "favorite", + "inserted_at", + "updated_at", + "owner", + "updated_by" + ] + } + }, + "required": ["type", "id", "attributes"] + } + }, + "links": { + "type": "object", + "properties": { + "first": { + "type": "string", + "description": "URL path to the first page if available.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10", + "nullable": true + }, + "prev": { + "type": "string", + "description": "URL path to the previous page.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7", + "nullable": true + }, + "next": { + "type": "string", + "description": "URL path to the next page.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4", + "nullable": true + }, + "last": { + "type": "string", + "description": "URL path to the last page if available.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295", + "nullable": true + } + }, + "required": ["prev", "next"] + } + }, + "required": ["data", "links"] + }, + "V2NotebookResponse_Output": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { "type": "string", "description": "Resource type.", "enum": ["notebook"] }, + "id": { "type": "string" }, + "attributes": { + "type": "object", + "properties": { + "name": { "type": "string" }, + "description": { "type": "string", "nullable": true }, + "favorite": { "type": "boolean" }, + "inserted_at": { "type": "string" }, + "updated_at": { "type": "string" }, + "owner": { + "type": "object", + "properties": { "id": { "type": "number" }, "username": { "type": "string" } }, + "required": ["id", "username"], + "description": "User who created the notebook.", + "nullable": true + }, + "updated_by": { + "type": "object", + "properties": { "id": { "type": "number" }, "username": { "type": "string" } }, + "required": ["id", "username"], + "description": "User who last wrote to the notebook.", + "nullable": true + }, + "content": { + "type": "object", + "properties": { + "schema_version": { "type": "number" }, + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["markdown"] }, + "text": { "type": "string" } + }, + "required": ["id", "type", "text"] + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["database"] }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"] + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ] + } + }, + "required": ["id", "type", "sql", "row_limit"] + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["log"] }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["absolute"] }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"] + }, + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["relative"] }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"] + } + ] + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"] + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ] + } + }, + "required": ["id", "type", "sql", "time_range"] + } + ] + } + } + }, + "required": ["schema_version", "cells"] + } + }, + "required": [ + "name", + "description", + "favorite", + "inserted_at", + "updated_at", + "owner", + "updated_by", + "content" + ] + } + }, + "required": ["type", "id", "attributes"] + } + }, + "required": ["data"] + }, + "V2CreateNotebookRequest": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { "type": "string", "description": "Resource type.", "enum": ["notebook"] }, + "attributes": { + "type": "object", + "properties": { + "name": { "type": "string", "minLength": 1, "maxLength": 255 }, + "description": { "type": "string", "maxLength": 10000 }, + "favorite": { "type": "boolean" }, + "content": { + "type": "object", + "properties": { + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["markdown"] }, + "text": { "type": "string" } + }, + "required": ["type", "text"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["database"] }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["log"] }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["absolute"] }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["relative"] }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"], + "additionalProperties": {} + } + ] + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql", "time_range"], + "additionalProperties": {} + } + ] + } + } + }, + "required": ["cells"] + } + }, + "required": ["name", "content"] + } + }, + "required": ["type", "attributes"] + } + }, + "required": ["data"] + }, + "V2UpdateNotebookRequest": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { "type": "string", "description": "Resource type.", "enum": ["notebook"] }, + "attributes": { + "type": "object", + "properties": { + "name": { "type": "string", "minLength": 1, "maxLength": 255 }, + "description": { "type": "string", "maxLength": 10000 }, + "favorite": { "type": "boolean" }, + "content": { + "description": "Replaces the notebook body. A cell keeps its identity by echoing back its `id`; a cell sent without an `id` is added as a new one.", + "type": "object", + "properties": { + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["markdown"] }, + "text": { "type": "string" } + }, + "required": ["type", "text"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["database"] }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { "type": "string" }, + "type": { "type": "string", "enum": ["log"] }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["absolute"] }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["relative"] }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"], + "additionalProperties": {} + } + ] + }, + "title": { "type": "string" }, + "view": { "type": "string", "enum": ["table", "chart"] }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { "type": "string", "enum": ["bar", "line"] }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { "type": "string", "enum": ["linear", "log"] }, + "cumulative": { "type": "boolean" }, + "show_labels": { "type": "boolean" } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql", "time_range"], + "additionalProperties": {} + } + ] + } + } + }, + "required": ["cells"] + } + } + } + }, + "required": ["type", "attributes"] + } + }, + "required": ["data"] + }, "V2TransferProjectBody": { "type": "object", "properties": { @@ -17685,7 +16413,7 @@ "shared_at": { "type": "string", "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.", "nullable": true }, @@ -17698,6 +16426,10 @@ "type": "string", "description": "Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier." }, + "custom_dns_name": { + "type": "string", + "description": "The custom DNS name configured on the AWS VPC Lattice resource configuration." + }, "resource_access_manager_resource_config_id": { "description": "ID of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" @@ -17716,7 +16448,8 @@ "status", "shared_at", "database_type", - "database_identifier" + "database_identifier", + "custom_dns_name" ] } }, @@ -17806,7 +16539,7 @@ "shared_at": { "type": "string", "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.", "nullable": true }, @@ -17819,6 +16552,10 @@ "type": "string", "description": "Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier." }, + "custom_dns_name": { + "type": "string", + "description": "The custom DNS name configured on the AWS VPC Lattice resource configuration." + }, "resource_access_manager_resource_config_id": { "description": "ID of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" @@ -17837,7 +16574,8 @@ "status", "shared_at", "database_type", - "database_identifier" + "database_identifier", + "custom_dns_name" ] } }, @@ -17846,7 +16584,7 @@ }, "required": ["data"] }, - "V2ListWorkersResponse_Output": { + "V2ListComputeInstancesResponse_Output": { "type": "object", "properties": { "data": { @@ -17857,9 +16595,13 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] + }, + "id": { + "type": "string", + "description": "Compute instance name.", + "example": "hello-world" }, - "id": { "type": "string", "description": "Worker name.", "example": "hello-world" }, "attributes": { "type": "object", "properties": { @@ -17920,7 +16662,7 @@ }, "required": ["data"] }, - "V2WorkerResponse_Output": { + "V2ComputeInstanceResponse_Output": { "type": "object", "properties": { "data": { @@ -17929,9 +16671,13 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] + }, + "id": { + "type": "string", + "description": "Compute instance name.", + "example": "hello-world" }, - "id": { "type": "string", "description": "Worker name.", "example": "hello-world" }, "attributes": { "type": "object", "properties": { @@ -17991,7 +16737,7 @@ }, "required": ["data"] }, - "V2WorkerUploadResponse_Output": { + "V2ComputeInstanceUploadResponse_Output": { "type": "object", "properties": { "data": { @@ -18000,7 +16746,7 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker_upload"] + "enum": ["project_compute_instance_upload"] }, "id": { "type": "string", @@ -18028,7 +16774,7 @@ }, "required": ["data"] }, - "V2DeployWorkerRequest": { + "V2DeployComputeInstanceRequest": { "type": "object", "properties": { "data": { @@ -18037,7 +16783,7 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] }, "attributes": { "type": "object", @@ -18209,7 +16955,7 @@ "properties": { "role": { "type": "string", - "enum": ["owner", "administrator", "developer", "read-only"], + "enum": ["owner", "administrator", "developer", "read-only", "no-access"], "description": "Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.", "example": "developer" }, @@ -18338,8 +17084,8 @@ }, "role": { "type": "string", - "enum": ["owner", "administrator", "developer", "read-only"], - "description": "Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.", + "enum": ["owner", "administrator", "developer", "read-only", "no-access"], + "description": "Role name to assign. Must be on an Enterprise plan to use the read-only or no-access roles. no-access grants no project visibility until project-scoped roles are assigned separately.", "example": "developer" }, "projects": { diff --git a/apps/docs/spec/common-api-sections.json b/apps/docs/spec/common-api-sections.json index 27e68b5ee4a..27487a7f2d5 100644 --- a/apps/docs/spec/common-api-sections.json +++ b/apps/docs/spec/common-api-sections.json @@ -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" - } - ] } ] diff --git a/apps/docs/spec/mcp_tools_permissions.json b/apps/docs/spec/mcp_tools_permissions.json index 82b8c4dfef9..09ade5b3bee 100644 --- a/apps/docs/spec/mcp_tools_permissions.json +++ b/apps/docs/spec/mcp_tools_permissions.json @@ -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"]], diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json index e37476014c4..3b7fab9e590 100644 --- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json @@ -629,7 +629,7 @@ }, "/v1/branches/{branch_id_or_ref}/diff": { "get": { - "description": "Diffs the specified database branch", + "description": "Diffs the specified database branch\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-diff-a-branch", "parameters": [ { @@ -706,17 +706,22 @@ "bearer": [] } ], - "summary": "[Beta] Diffs a database branch", + "summary": "Diffs a database branch", "tags": ["Environments"], "x-badges": [ { "name": "OAuth scope: environment:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["branching_development_write"], ["branching_production_write"]], - "x-oauth-scope": "environment:write" + "x-oauth-scope": "environment:write", + "x-scalar-stability": "experimental" } }, "/v1/projects": { @@ -819,6 +824,7 @@ }, "/v1/projects/available-regions": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-available-regions", "parameters": [ { @@ -890,16 +896,21 @@ "bearer": [] } ], - "summary": "[Beta] Gets the list of available regions that can be used for a new project", + "summary": "Gets the list of available regions that can be used for a new project", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: organizations:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra"], - "x-oauth-scope": "organizations:read" + "x-oauth-scope": "organizations:read", + "x-scalar-stability": "experimental" } }, "/v1/organizations": { @@ -1001,6 +1012,7 @@ }, "/v1/oauth/authorize": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-authorize-user", "parameters": [ { @@ -1124,14 +1136,21 @@ "description": "Rate limit exceeded" } }, - "summary": "[Beta] Authorize user through oauth", + "summary": "Authorize user through oauth", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [ + { + "name": "Beta", + "position": "before" + } + ], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/token": { "post": { - "description": "Supports `authorization_code`, `refresh_token`, and `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only.", + "description": "Supports `authorization_code`, `refresh_token`, and `urn:ietf:params:oauth:grant-type:jwt-bearer` grant types. The `jwt-bearer` grant type (IDJAG — identity-directed JWT assertion) is in beta and available on Team and Enterprise plans only.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-exchange-oauth-token", "parameters": [], "requestBody": { @@ -1165,13 +1184,21 @@ "description": "Rate limit exceeded" } }, - "summary": "[Beta] Exchange auth code for user's access and refresh token", + "summary": "Exchange auth code for user's access and refresh token", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [ + { + "name": "Beta", + "position": "before" + } + ], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/revoke": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-revoke-token", "parameters": [], "requestBody": { @@ -1198,9 +1225,16 @@ "description": "Rate limit exceeded" } }, - "summary": "[Beta] Revoke oauth app authorization and it's corresponding tokens", + "summary": "Revoke oauth app authorization and it's corresponding tokens", "tags": ["OAuth"], - "x-endpoint-owners": ["auth", "control-plane"] + "x-badges": [ + { + "name": "Beta", + "position": "before" + } + ], + "x-endpoint-owners": ["auth", "control-plane"], + "x-scalar-stability": "experimental" } }, "/v1/oauth/authorize/project-claim": { @@ -2648,6 +2682,7 @@ }, "/v1/projects/{ref}/custom-hostname": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-hostname-config", "parameters": [ { @@ -2693,19 +2728,25 @@ "bearer": [] } ], - "summary": "[Beta] Gets project's custom hostname config", + "summary": "Gets project's custom hostname config", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_read"]], - "x-oauth-scope": "domains:read" + "x-oauth-scope": "domains:read", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-Delete hostname config", "parameters": [ { @@ -2753,21 +2794,27 @@ "bearer": [] } ], - "summary": "[Beta] Deletes a project's custom hostname configuration", + "summary": "Deletes a project's custom hostname configuration", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/initialize": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-hostname-config", "parameters": [ { @@ -2823,21 +2870,27 @@ "bearer": [] } ], - "summary": "[Beta] Updates project's custom hostname configuration", + "summary": "Updates project's custom hostname configuration", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/reverify": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-verify-dns-config", "parameters": [ { @@ -2883,21 +2936,27 @@ "bearer": [] } ], - "summary": "[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration", + "summary": "Attempts to verify the DNS configuration for project's custom hostname configuration", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/custom-hostname/activate": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-activate-custom-hostname", "parameters": [ { @@ -2943,21 +3002,27 @@ "bearer": [] } ], - "summary": "[Beta] Activates a custom hostname for a project.", + "summary": "Activates a custom hostname for a project.", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["custom_domain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/jit-access": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-jit-access-config", "parameters": [ { @@ -3037,19 +3102,25 @@ "bearer": [] } ], - "summary": "[Beta] Get project's temporary access configuration.", + "summary": "Get project's temporary access configuration.", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["security", "control-plane"], "x-fga-permissions": [["project_admin_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-jit-access-config", "parameters": [ { @@ -3139,21 +3210,27 @@ "bearer": [] } ], - "summary": "[Beta] Update project's temporary access configuration.", + "summary": "Update project's temporary access configuration.", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["security", "control-plane"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans/retrieve": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-list-all-network-bans", "parameters": [ { @@ -3199,21 +3276,27 @@ "bearer": [] } ], - "summary": "[Beta] Gets project's network bans", + "summary": "Gets project's network bans", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans/retrieve/enriched": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-list-all-network-bans-enriched", "parameters": [ { @@ -3259,21 +3342,27 @@ "bearer": [] } ], - "summary": "[Beta] Gets project's network bans with additional information about which databases they affect", + "summary": "Gets project's network bans with additional information about which databases they affect", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-bans": { "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-delete-network-bans", "parameters": [ { @@ -3322,21 +3411,27 @@ "bearer": [] } ], - "summary": "[Beta] Remove network bans.", + "summary": "Remove network bans.", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_network_bans_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-restrictions": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-network-restrictions", "parameters": [ { @@ -3382,19 +3477,25 @@ "bearer": [] } ], - "summary": "[Beta] Gets project's network restrictions", + "summary": "Gets project's network restrictions", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" }, "patch": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Alpha** stage.", "operationId": "v1-patch-network-restrictions", "parameters": [ { @@ -3450,21 +3551,27 @@ "bearer": [] } ], - "summary": "[Alpha] Updates project's network restrictions by adding or removing CIDRs", + "summary": "Updates project's network restrictions by adding or removing CIDRs", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:write", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/network-restrictions/apply": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-network-restrictions", "parameters": [ { @@ -3520,21 +3627,27 @@ "bearer": [] } ], - "summary": "[Beta] Updates project's network restrictions", + "summary": "Updates project's network restrictions", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_network_restrictions_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/pgsodium": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-pgsodium-config", "parameters": [ { @@ -3580,19 +3693,25 @@ "bearer": [] } ], - "summary": "[Beta] Gets project's pgsodium config", + "summary": "Gets project's pgsodium config", "tags": ["Secrets"], "x-badges": [ { "name": "OAuth scope: secrets:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "secrets:read" + "x-oauth-scope": "secrets:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-pgsodium-config", "parameters": [ { @@ -3648,17 +3767,22 @@ "bearer": [] } ], - "summary": "[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", + "summary": "Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.", "tags": ["Secrets"], "x-badges": [ { "name": "OAuth scope: secrets:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra"], "x-fga-permissions": [["project_admin_write"]], - "x-oauth-scope": "secrets:write" + "x-oauth-scope": "secrets:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/postgrest": { @@ -4165,6 +4289,7 @@ }, "/v1/projects/{ref}/ssl-enforcement": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-ssl-enforcement-config", "parameters": [ { @@ -4210,19 +4335,25 @@ "bearer": [] } ], - "summary": "[Beta] Get project's SSL enforcement configuration.", + "summary": "Get project's SSL enforcement configuration.", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_ssl_config_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" }, "put": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-update-ssl-enforcement-config", "parameters": [ { @@ -4278,17 +4409,22 @@ "bearer": [] } ], - "summary": "[Beta] Update project's SSL enforcement configuration.", + "summary": "Update project's SSL enforcement configuration.", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["database_ssl_config_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/types/typescript": { @@ -4364,6 +4500,7 @@ }, "/v1/projects/{ref}/vanity-subdomain": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-vanity-subdomain-config", "parameters": [ { @@ -4419,7 +4556,7 @@ "bearer": [] } ], - "summary": "[Beta] Gets current vanity subdomain config", + "summary": "Gets current vanity subdomain config", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ @@ -4427,6 +4564,10 @@ "name": "OAuth scope: domains:read", "position": "after" }, + { + "name": "Beta", + "position": "before" + }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" @@ -4434,9 +4575,11 @@ ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_read"]], - "x-oauth-scope": "domains:read" + "x-oauth-scope": "domains:read", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-deactivate-vanity-subdomain-config", "parameters": [ { @@ -4475,21 +4618,27 @@ "bearer": [] } ], - "summary": "[Beta] Deletes a project's vanity subdomain configuration", + "summary": "Deletes a project's vanity subdomain configuration", "tags": ["Domains"], "x-badges": [ { "name": "OAuth scope: domains:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/vanity-subdomain/check-availability": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-check-vanity-subdomain-availability", "parameters": [ { @@ -4555,7 +4704,7 @@ "bearer": [] } ], - "summary": "[Beta] Checks vanity subdomain availability", + "summary": "Checks vanity subdomain availability", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ @@ -4563,6 +4712,10 @@ "name": "OAuth scope: domains:write", "position": "after" }, + { + "name": "Beta", + "position": "before" + }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" @@ -4570,11 +4723,13 @@ ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/vanity-subdomain/activate": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-activate-vanity-subdomain-config", "parameters": [ { @@ -4640,7 +4795,7 @@ "bearer": [] } ], - "summary": "[Beta] Activates a vanity subdomain for a project.", + "summary": "Activates a vanity subdomain for a project.", "tags": ["Domains"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ @@ -4648,6 +4803,10 @@ "name": "OAuth scope: domains:write", "position": "after" }, + { + "name": "Beta", + "position": "before" + }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" @@ -4655,11 +4814,13 @@ ], "x-endpoint-owners": ["infra", "control-plane"], "x-fga-permissions": [["vanity_subdomain_write"]], - "x-oauth-scope": "domains:write" + "x-oauth-scope": "domains:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-upgrade-postgres-version", "parameters": [ { @@ -4715,21 +4876,27 @@ "bearer": [] } ], - "summary": "[Beta] Upgrades the project's Postgres version", + "summary": "Upgrades the project's Postgres version", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_write", "database_write"]], - "x-oauth-scope": "projects:write" + "x-oauth-scope": "projects:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade/eligibility": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-postgres-upgrade-eligibility", "parameters": [ { @@ -4775,21 +4942,27 @@ "bearer": [] } ], - "summary": "[Beta] Returns the project's eligibility for upgrades", + "summary": "Returns the project's eligibility for upgrades", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_read", "database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/upgrade/status": { "get": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-get-postgres-upgrade-status", "parameters": [ { @@ -4844,17 +5017,22 @@ "bearer": [] } ], - "summary": "[Beta] Gets the latest status of the project's upgrade", + "summary": "Gets the latest status of the project's upgrade", "tags": ["Projects"], "x-badges": [ { "name": "OAuth scope: projects:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["project_admin_read", "database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/readonly": { @@ -4972,6 +5150,7 @@ }, "/v1/projects/{ref}/read-replicas/setup": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-setup-a-read-replica", "parameters": [ { @@ -5030,21 +5209,27 @@ "bearer": [] } ], - "summary": "[Beta] Set up a read replica", + "summary": "Set up a read replica", "tags": ["Database"], "x-allowed-plans": ["Pro", "Team", "Enterprise"], "x-badges": [ + { + "name": "Beta", + "position": "before" + }, { "name": "Only available on Pro, Team, Enterprise", "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], - "x-fga-permissions": [["infra_read_replicas_write"]] + "x-fga-permissions": [["infra_read_replicas_write"]], + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/read-replicas/remove": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-remove-a-read-replica", "parameters": [ { @@ -5093,10 +5278,17 @@ "bearer": [] } ], - "summary": "[Beta] Remove a read replica", + "summary": "Remove a read replica", "tags": ["Database"], + "x-badges": [ + { + "name": "Beta", + "position": "before" + } + ], "x-endpoint-owners": ["control-plane", "infra"], - "x-fga-permissions": [["infra_read_replicas_write"]] + "x-fga-permissions": [["infra_read_replicas_write"]], + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/health": { @@ -6631,7 +6823,6 @@ }, "/v1/projects/{ref}/advisors/performance": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-performance-advisors", "parameters": [ @@ -6685,12 +6876,12 @@ ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["advisors_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/advisors/security": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-security-advisors", "parameters": [ @@ -6754,13 +6945,14 @@ ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["advisors_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/analytics/endpoints/logs.all": { "get": { "deprecated": true, - "description": "Executes a SQL query on the project's logs.\n\nEither the `iso_timestamp_start` and `iso_timestamp_end` parameters must be provided.\nIf both are not provided, only the last 1 minute of logs will be queried.\nThe timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.\n\nNote: Unless the `sql` parameter is provided, only edge_logs will be queried. See the [log query docs](https://supabase.com/docs/guides/monitoring-and-debugging/logs#logs-explorer) for all available sources.\n", + "description": "This endpoint has been removed and always responds with `410 Gone`. Use `GET /v1/projects/{ref}/analytics/endpoints/logs` instead. See the [migration guide](https://supabase.com/changelog/48235-migration-of-supabase-management-api-logs-all-analytics-endpoint-to-logs-endpoint).", "operationId": "v1-get-project-logs-all", "parameters": [ { @@ -6775,60 +6967,18 @@ "example": "abcdefghijklmnopqrst", "type": "string" } - }, - { - "name": "sql", - "required": false, - "in": "query", - "description": "Custom SQL query to execute on the logs. See [querying logs](https://supabase.com/docs/guides/monitoring-and-debugging/logs#querying-with-the-logs-explorer) for more details.", - "schema": { - "example": "select event_message from edge_logs limit 10", - "type": "string" - } - }, - { - "name": "iso_timestamp_start", - "required": false, - "in": "query", - "schema": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "example": "2025-03-01T00:00:00Z", - "type": "string" - } - }, - { - "name": "iso_timestamp_end", - "required": false, - "in": "query", - "schema": { - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", - "example": "2025-03-01T23:59:59Z", - "type": "string" - } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsResponse_Output" - } - } - } - }, "401": { "description": "Unauthorized" }, - "402": { - "description": "Usage exceeded. Enable additional usage to continue querying" - }, "403": { "description": "Forbidden action" }, + "410": { + "description": "This endpoint has been removed" + }, "429": { "description": "Rate limit exceeded" } @@ -7204,6 +7354,7 @@ }, "/v1/projects/{ref}/cli/login-role": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-create-login-role", "parameters": [ { @@ -7259,19 +7410,25 @@ "bearer": [] } ], - "summary": "[Beta] Create a login role for CLI with temporary password", + "summary": "Create a login role for CLI with temporary password", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" }, "delete": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-delete-login-roles", "parameters": [ { @@ -7317,17 +7474,22 @@ "bearer": [] } ], - "summary": "[Beta] Delete existing login roles used by CLI", + "summary": "Delete existing login roles used by CLI", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["dev-workflows"], "x-fga-permissions": [["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/migrations": { @@ -7735,6 +7897,7 @@ }, "/v1/projects/{ref}/database/query": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-run-a-query", "parameters": [ { @@ -7783,22 +7946,27 @@ "bearer": [] } ], - "summary": "[Beta] Run sql query", + "summary": "Run sql query", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"], ["database_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/query/read-only": { "post": { - "description": "All entity references must be schema qualified.", + "description": "All entity references must be schema qualified.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-read-only-query", "parameters": [ { @@ -7847,21 +8015,27 @@ "bearer": [] } ], - "summary": "[Beta] Run a sql query as supabase_read_only_user", + "summary": "Run a sql query as supabase_read_only_user", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:read", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"]], - "x-oauth-scope": "database:read" + "x-oauth-scope": "database:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/webhooks/enable": { "post": { + "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.\n\nThis endpoint is currently in its **Beta** stage.", "operationId": "v1-enable-database-webhook", "parameters": [ { @@ -7900,22 +8074,26 @@ "bearer": [] } ], - "summary": "[Beta] Enables Database Webhooks on the project", + "summary": "Enables Database Webhooks on the project", "tags": ["Database"], "x-badges": [ { "name": "OAuth scope: database:write", "position": "after" + }, + { + "name": "Beta", + "position": "before" } ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [["database_webhooks_config_write"]], - "x-oauth-scope": "database:write" + "x-oauth-scope": "database:write", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/context": { "get": { - "deprecated": true, "description": "This is an **experimental** endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.", "operationId": "v1-get-database-metadata", "parameters": [ @@ -7969,7 +8147,8 @@ ], "x-endpoint-owners": ["control-plane"], "x-fga-permissions": [["database_read"]], - "x-oauth-scope": "projects:read" + "x-oauth-scope": "projects:read", + "x-scalar-stability": "experimental" } }, "/v1/projects/{ref}/database/password": { @@ -12549,7 +12728,7 @@ "type": "string" } }, - "required": ["schema_version", "sql"] + "required": ["sql"] } }, "required": [ @@ -17938,6 +18117,9 @@ "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, + "act": { + "type": "string" + }, "user_role": { "type": "object", "properties": { @@ -17987,7 +18169,7 @@ "required": ["role"] } }, - "required": ["user_id", "user_role"] + "required": ["user_role"] }, "JitListAccessResponse_Output": { "type": "object", @@ -19675,7 +19857,7 @@ "max_concurrent_users": { "type": "integer", "minimum": 1, - "maximum": 50000, + "maximum": 300000, "description": "Sets maximum number of concurrent users rate limit", "nullable": true }, @@ -19729,6 +19911,13 @@ "presence_enabled": { "type": "boolean", "description": "Whether to enable presence" + }, + "admin_suspended_at": { + "type": "string", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "description": "If set, the Realtime service has been suspended by an admin.", + "nullable": true } }, "required": [ @@ -19743,7 +19932,8 @@ "max_presence_events_per_second", "max_payload_size_in_kb", "suspend", - "presence_enabled" + "presence_enabled", + "admin_suspended_at" ] }, "UpdateRealtimeConfigBody": { @@ -19768,7 +19958,7 @@ "max_concurrent_users": { "type": "integer", "minimum": 1, - "maximum": 50000, + "maximum": 300000, "description": "Sets maximum number of concurrent users rate limit" }, "max_events_per_second": { diff --git a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json index dfd94d40453..d22e27c0f8d 100644 --- a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json +++ b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json @@ -609,7 +609,7 @@ }, "/v2/projects/{ref}/config": { "get": { - "description": "Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. `storage` is read live from the storage service; the rest come from this platform's own records.", + "description": "Returns the project's database, pooler, Auth, Data API, Realtime and Storage configuration — the same configuration a branch inherits from its base project. Each is the effective config, so a setting the project has never overridden is reported at its platform default rather than as null. Auth secrets are returned as an HMAC of their value. `storage` is read live from the storage service; the rest come from this platform's own records.\n\nThis endpoint is currently in its **Alpha** stage.", "operationId": "v2-get-project-config", "parameters": [ { @@ -673,8 +673,14 @@ "bearer": [] } ], - "summary": "[Alpha] Get a project's service configuration", + "summary": "Get a project's service configuration", "tags": ["Projects"], + "x-badges": [ + { + "name": "Alpha", + "position": "before" + } + ], "x-endpoint-owners": ["control-plane", "infra"], "x-fga-permissions": [ [ @@ -687,7 +693,589 @@ "realtime_config_read", "storage_config_read" ] - ] + ], + "x-scalar-stability": "experimental" + } + }, + "/v2/projects/{ref}/notebooks": { + "get": { + "description": "Returns a cursor-paginated list of the project notebooks. Notebook bodies are omitted — read a single notebook to get its cells.", + "operationId": "v2-list-notebooks", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "page", + "required": false, + "in": "query", + "schema": { + "properties": { + "size": { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "after": { + "type": "string", + "minLength": 1 + }, + "before": { + "type": "string", + "minLength": 1 + } + }, + "type": "object" + }, + "style": "deepObject" + }, + { + "name": "filter", + "required": false, + "in": "query", + "schema": { + "properties": { + "name": { + "type": "string", + "minLength": 1 + } + }, + "type": "object" + }, + "style": "deepObject" + }, + { + "name": "sort", + "required": false, + "in": "query", + "schema": { + "type": "string", + "enum": ["name", "-name", "inserted_at", "-inserted_at"] + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2ListNotebooksResponse_Output" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "500": { + "description": "Failed to retrieve project's notebooks", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "List notebooks of a project", + "tags": ["Projects"], + "x-badges": [ + { + "name": "OAuth scope: database:read", + "position": "after" + } + ], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_read"]], + "x-oauth-scope": "database:read" + }, + "post": { + "description": "Creates a notebook shared with everyone who has access to the project. Cell ids are assigned by the server and returned in the response.", + "operationId": "v2-create-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2CreateNotebookRequest" + } + } + } + }, + "responses": { + "201": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2NotebookResponse_Output" + } + } + } + }, + "400": { + "description": "The request repeats a cell id", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "500": { + "description": "Failed to create notebook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Create a notebook", + "tags": ["Projects"], + "x-badges": [ + { + "name": "OAuth scope: database:write", + "position": "after" + } + ], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" + } + }, + "/v2/projects/{ref}/notebooks/{id}": { + "get": { + "operationId": "v2-get-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2NotebookResponse_Output" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "500": { + "description": "Failed to retrieve notebook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Get a notebook", + "tags": ["Projects"], + "x-badges": [ + { + "name": "OAuth scope: database:read", + "position": "after" + } + ], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_read"]], + "x-oauth-scope": "database:read" + }, + "patch": { + "description": "Updates the attributes provided and leaves the rest untouched. Sending `content` replaces the whole notebook body.", + "operationId": "v2-update-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2UpdateNotebookRequest" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2NotebookResponse_Output" + } + } + } + }, + "400": { + "description": "The request references a cell that does not exist on this notebook, or repeats a cell id", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "500": { + "description": "Failed to update notebook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Update a notebook", + "tags": ["Projects"], + "x-badges": [ + { + "name": "OAuth scope: database:write", + "position": "after" + } + ], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" + }, + "delete": { + "operationId": "v2-delete-notebook", + "parameters": [ + { + "name": "ref", + "required": true, + "in": "path", + "description": "Project ref", + "schema": { + "minLength": 20, + "maxLength": 20, + "pattern": "^[a-z]+$", + "example": "abcdefghijklmnopqrst", + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", + "example": "44444444-4444-4444-8444-444444444444", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "" + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "403": { + "description": "Forbidden action", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "404": { + "description": "Notebook not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "429": { + "description": "Rate limit exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + }, + "500": { + "description": "Failed to delete notebook", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseBody" + } + } + } + } + }, + "security": [ + { + "bearer": [] + } + ], + "summary": "Delete a notebook", + "tags": ["Projects"], + "x-badges": [ + { + "name": "OAuth scope: database:write", + "position": "after" + } + ], + "x-endpoint-owners": ["control-plane"], + "x-fga-permissions": [["project_notebooks_write"]], + "x-oauth-scope": "database:write" } }, "/v2/projects/{ref}/transfers/previews": { @@ -1210,10 +1798,10 @@ "x-fga-permissions": [["project_admin_write"]] } }, - "/v2/projects/{ref}/workers": { + "/v2/projects/{ref}/compute": { "get": { - "description": "Returns all workers you've previously deployed to the specified project.", - "operationId": "v2-list-all-workers", + "description": "Returns all compute instances you've previously deployed to the specified project.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-list-all-compute-instances", "parameters": [ { "name": "ref", @@ -1235,7 +1823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/V2ListWorkersResponse_Output" + "$ref": "#/components/schemas/V2ListComputeInstancesResponse_Output" } } } @@ -1276,23 +1864,28 @@ "bearer": [] } ], - "summary": "[Alpha] List all workers", - "tags": ["Workers"], + "summary": "List all compute instances", + "tags": ["Compute"], "x-badges": [ { "name": "OAuth scope: edge_functions:read", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_read"]], - "x-oauth-scope": "edge_functions:read" + "x-oauth-scope": "edge_functions:read", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}": { + "/v2/projects/{ref}/compute/{name}": { "get": { - "description": "Returns a worker along with its instance tally. Poll this after a deploy until `build_state` leaves `building`.", - "operationId": "v2-get-a-worker", + "description": "Returns a compute instance along with the counts of its running instances. Poll this after a deploy until `build_state` leaves `building`.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-get-a-compute-instance", "parameters": [ { "name": "ref", @@ -1324,7 +1917,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/V2WorkerResponse_Output" + "$ref": "#/components/schemas/V2ComputeInstanceResponse_Output" } } } @@ -1365,21 +1958,26 @@ "bearer": [] } ], - "summary": "[Alpha] Retrieve a worker", - "tags": ["Workers"], + "summary": "Retrieve a compute instance", + "tags": ["Compute"], "x-badges": [ { "name": "OAuth scope: edge_functions:read", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_read"]], - "x-oauth-scope": "edge_functions:read" + "x-oauth-scope": "edge_functions:read", + "x-scalar-stability": "experimental" }, "delete": { - "description": "Tombstones the worker. Its instances and image are torn down asynchronously.", - "operationId": "v2-delete-a-worker", + "description": "Tombstones the compute instance. Its running instances and image are torn down asynchronously.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-delete-a-compute-instance", "parameters": [ { "name": "ref", @@ -1445,23 +2043,28 @@ "bearer": [] } ], - "summary": "[Alpha] Delete a worker", - "tags": ["Workers"], + "summary": "Delete a compute instance", + "tags": ["Compute"], "x-badges": [ { "name": "OAuth scope: edge_functions:write", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}/uploads": { + "/v2/projects/{ref}/compute/{name}/uploads": { "post": { - "description": "PUT the `.tar.gz` build context to the returned `url` before `expires_at`, then deploy with the upload id as `context_upload_id`. The bytes go straight to storage — no management API request carries them.", - "operationId": "v2-create-worker-upload", + "description": "PUT the `.tar.gz` build context to the returned `url` before `expires_at`, then deploy with the upload id as `context_upload_id`. The bytes go straight to storage — no management API request carries them.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-create-compute-instance-upload", "parameters": [ { "name": "ref", @@ -1493,7 +2096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/V2WorkerUploadResponse_Output" + "$ref": "#/components/schemas/V2ComputeInstanceUploadResponse_Output" } } } @@ -1534,23 +2137,28 @@ "bearer": [] } ], - "summary": "[Alpha] Mint a presigned slot for a build-context upload", - "tags": ["Workers"], + "summary": "Mint a presigned slot for a build-context upload", + "tags": ["Compute"], "x-badges": [ { "name": "OAuth scope: edge_functions:write", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, - "/v2/projects/{ref}/workers/{name}/deploy": { + "/v2/projects/{ref}/compute/{name}/deploy": { "post": { - "description": "Creates the worker if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the worker reaches `build_state` `active` or `failed` later.", - "operationId": "v2-deploy-a-worker", + "description": "Creates the compute instance if it does not exist, building from a context staged through the uploads endpoint. The build runs asynchronously: this answers 202 and the compute instance reaches `build_state` `active` or `failed` later.\n\nThis endpoint is currently in its **Alpha** stage.", + "operationId": "v2-deploy-a-compute-instance", "parameters": [ { "name": "ref", @@ -1581,7 +2189,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/V2DeployWorkerRequest" + "$ref": "#/components/schemas/V2DeployComputeInstanceRequest" } } } @@ -1592,7 +2200,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/V2WorkerResponse_Output" + "$ref": "#/components/schemas/V2ComputeInstanceResponse_Output" } } } @@ -1633,17 +2241,22 @@ "bearer": [] } ], - "summary": "[Alpha] Deploy a worker", - "tags": ["Workers"], + "summary": "Deploy a compute instance", + "tags": ["Compute"], "x-badges": [ { "name": "OAuth scope: edge_functions:write", "position": "after" + }, + { + "name": "Alpha", + "position": "before" } ], "x-endpoint-owners": ["functions"], "x-fga-permissions": [["workers_write"]], - "x-oauth-scope": "edge_functions:write" + "x-oauth-scope": "edge_functions:write", + "x-scalar-stability": "experimental" } }, "/v2/organizations/{slug}/members": { @@ -2659,182 +3272,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -3562,182 +3999,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -4591,182 +4852,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -5507,182 +5592,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -6516,182 +6425,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -7646,182 +7379,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -8711,182 +8268,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -9745,142 +9126,6 @@ }, "required": ["code", "message"], "title": "EndpointTestWrongEventType" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" } ] } @@ -9910,22 +9155,6 @@ "description": "Only event types that the endpoint is subscribed to can be specified." } } - }, - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } } } } @@ -10897,182 +10126,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -11787,182 +10840,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -12862,182 +11739,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -13763,182 +12464,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -14790,182 +13315,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -15704,182 +14053,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -16711,182 +14884,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -17839,182 +15836,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -18902,182 +16723,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -19934,142 +17579,6 @@ }, "required": ["code", "message"], "title": "EndpointTestWrongEventType" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" } ] } @@ -20099,22 +17608,6 @@ "description": "Only event types that the endpoint is subscribed to can be specified." } } - }, - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } } } } @@ -21084,182 +18577,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -21972,182 +19289,6 @@ } } }, - "400": { - "description": "Multiple error responses", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "error": { - "oneOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_slug" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid organization slug" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidSlug" - }, - { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "code": { - "type": "string", - "const": "bad_request.invalid_ref" - }, - "message": { - "type": "string", - "const": "Bad Request: Invalid project ref" - }, - "description": { - "type": "string" - }, - "links": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "describedby": { - "type": "string" - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - } - }, - "required": ["href"] - } - }, - "meta": { - "type": "object", - "propertyNames": { - "type": "string" - }, - "additionalProperties": {} - }, - "issues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "required": ["code", "message"], - "title": "InvalidRef" - } - ] - } - }, - "required": ["error"], - "$defs": { - "APIErrorObject": { - "$ref": "#/components/schemas/APIErrorObject" - } - } - }, - "examples": { - "InvalidSlug": { - "value": { - "error": { - "code": "bad_request.invalid_slug", - "message": "Bad Request: Invalid organization slug" - } - } - }, - "InvalidRef": { - "value": { - "error": { - "code": "bad_request.invalid_ref", - "message": "Bad Request: Invalid project ref" - } - } - } - } - } - } - }, "401": { "description": "GenericUnauthorized", "content": { @@ -24754,6 +21895,951 @@ }, "required": ["data"] }, + "V2ListNotebooksResponse_Output": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type.", + "enum": ["notebook"] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "favorite": { + "type": "boolean" + }, + "inserted_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "username": { + "type": "string" + } + }, + "required": ["id", "username"], + "description": "User who created the notebook.", + "nullable": true + }, + "updated_by": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "username": { + "type": "string" + } + }, + "required": ["id", "username"], + "description": "User who last wrote to the notebook.", + "nullable": true + } + }, + "required": [ + "name", + "description", + "favorite", + "inserted_at", + "updated_at", + "owner", + "updated_by" + ] + } + }, + "required": ["type", "id", "attributes"] + } + }, + "links": { + "type": "object", + "properties": { + "first": { + "type": "string", + "description": "URL path to the first page if available.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10", + "nullable": true + }, + "prev": { + "type": "string", + "description": "URL path to the previous page.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7", + "nullable": true + }, + "next": { + "type": "string", + "description": "URL path to the next page.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4", + "nullable": true + }, + "last": { + "type": "string", + "description": "URL path to the last page if available.", + "example": "/v2/projects/{ref}/notebooks?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295", + "nullable": true + } + }, + "required": ["prev", "next"] + } + }, + "required": ["data", "links"] + }, + "V2NotebookResponse_Output": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type.", + "enum": ["notebook"] + }, + "id": { + "type": "string" + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "favorite": { + "type": "boolean" + }, + "inserted_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "username": { + "type": "string" + } + }, + "required": ["id", "username"], + "description": "User who created the notebook.", + "nullable": true + }, + "updated_by": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "username": { + "type": "string" + } + }, + "required": ["id", "username"], + "description": "User who last wrote to the notebook.", + "nullable": true + }, + "content": { + "type": "object", + "properties": { + "schema_version": { + "type": "number" + }, + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["markdown"] + }, + "text": { + "type": "string" + } + }, + "required": ["id", "type", "text"] + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["database"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"] + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ] + } + }, + "required": ["id", "type", "sql", "row_limit"] + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["log"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["absolute"] + }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["relative"] + }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"] + } + ] + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"] + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ] + } + }, + "required": ["id", "type", "sql", "time_range"] + } + ] + } + } + }, + "required": ["schema_version", "cells"] + } + }, + "required": [ + "name", + "description", + "favorite", + "inserted_at", + "updated_at", + "owner", + "updated_by", + "content" + ] + } + }, + "required": ["type", "id", "attributes"] + } + }, + "required": ["data"] + }, + "V2CreateNotebookRequest": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type.", + "enum": ["notebook"] + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 10000 + }, + "favorite": { + "type": "boolean" + }, + "content": { + "type": "object", + "properties": { + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["markdown"] + }, + "text": { + "type": "string" + } + }, + "required": ["type", "text"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["database"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["log"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["absolute"] + }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["relative"] + }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"], + "additionalProperties": {} + } + ] + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql", "time_range"], + "additionalProperties": {} + } + ] + } + } + }, + "required": ["cells"] + } + }, + "required": ["name", "content"] + } + }, + "required": ["type", "attributes"] + } + }, + "required": ["data"] + }, + "V2UpdateNotebookRequest": { + "type": "object", + "properties": { + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Resource type.", + "enum": ["notebook"] + }, + "attributes": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 10000 + }, + "favorite": { + "type": "boolean" + }, + "content": { + "description": "Replaces the notebook body. A cell keeps its identity by echoing back its `id`; a cell sent without an `id` is added as a new one.", + "type": "object", + "properties": { + "cells": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["markdown"] + }, + "text": { + "type": "string" + } + }, + "required": ["type", "text"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["database"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project database." + }, + "row_limit": { + "default": 100, + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + }, + "database_identifier": { + "description": "Read replica to run against. Omit to use the primary database.", + "type": "string" + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "enum": ["log"] + }, + "sql": { + "type": "string", + "description": "SQL run against the project logs." + }, + "time_range": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["absolute"] + }, + "start": { + "type": "string", + "description": "ISO 8601 start of the range." + }, + "end": { + "type": "string", + "description": "ISO 8601 end of the range." + } + }, + "required": ["type", "start", "end"], + "additionalProperties": {} + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["relative"] + }, + "unit": { + "type": "string", + "enum": ["minute", "hour", "day", "week", "month", "year"] + }, + "amount": { + "type": "integer", + "exclusiveMinimum": true, + "maximum": 9007199254740991, + "minimum": 0 + } + }, + "required": ["type", "unit", "amount"], + "additionalProperties": {} + } + ] + }, + "title": { + "type": "string" + }, + "view": { + "type": "string", + "enum": ["table", "chart"] + }, + "chart": { + "description": "Chart configuration, retained even while `view` is `table`.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["bar", "line"] + }, + "x_column": { + "type": "string", + "description": "Result column used for the x axis." + }, + "y_series": { + "maxItems": 3, + "type": "array", + "items": { + "type": "object", + "properties": { + "column": { + "type": "string", + "description": "Result column plotted as a series." + } + }, + "required": ["column"], + "additionalProperties": {} + } + }, + "scale": { + "type": "string", + "enum": ["linear", "log"] + }, + "cumulative": { + "type": "boolean" + }, + "show_labels": { + "type": "boolean" + } + }, + "required": [ + "type", + "x_column", + "y_series", + "scale", + "cumulative", + "show_labels" + ], + "additionalProperties": {} + } + }, + "required": ["type", "sql", "time_range"], + "additionalProperties": {} + } + ] + } + } + }, + "required": ["cells"] + } + } + } + }, + "required": ["type", "attributes"] + } + }, + "required": ["data"] + }, "V2TransferProjectBody": { "type": "object", "properties": { @@ -24896,7 +22982,7 @@ "shared_at": { "type": "string", "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.", "nullable": true }, @@ -24909,6 +22995,10 @@ "type": "string", "description": "Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier." }, + "custom_dns_name": { + "type": "string", + "description": "The custom DNS name configured on the AWS VPC Lattice resource configuration." + }, "resource_access_manager_resource_config_id": { "description": "ID of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" @@ -24927,7 +23017,8 @@ "status", "shared_at", "database_type", - "database_identifier" + "database_identifier", + "custom_dns_name" ] } }, @@ -25019,7 +23110,7 @@ "shared_at": { "type": "string", "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.", "nullable": true }, @@ -25032,6 +23123,10 @@ "type": "string", "description": "Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier." }, + "custom_dns_name": { + "type": "string", + "description": "The custom DNS name configured on the AWS VPC Lattice resource configuration." + }, "resource_access_manager_resource_config_id": { "description": "ID of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" @@ -25050,7 +23145,8 @@ "status", "shared_at", "database_type", - "database_identifier" + "database_identifier", + "custom_dns_name" ] } }, @@ -25059,7 +23155,7 @@ }, "required": ["data"] }, - "V2ListWorkersResponse_Output": { + "V2ListComputeInstancesResponse_Output": { "type": "object", "properties": { "data": { @@ -25070,11 +23166,11 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] }, "id": { "type": "string", - "description": "Worker name.", + "description": "Compute instance name.", "example": "hello-world" }, "attributes": { @@ -25159,7 +23255,7 @@ }, "required": ["data"] }, - "V2WorkerResponse_Output": { + "V2ComputeInstanceResponse_Output": { "type": "object", "properties": { "data": { @@ -25168,11 +23264,11 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] }, "id": { "type": "string", - "description": "Worker name.", + "description": "Compute instance name.", "example": "hello-world" }, "attributes": { @@ -25256,7 +23352,7 @@ }, "required": ["data"] }, - "V2WorkerUploadResponse_Output": { + "V2ComputeInstanceUploadResponse_Output": { "type": "object", "properties": { "data": { @@ -25265,7 +23361,7 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker_upload"] + "enum": ["project_compute_instance_upload"] }, "id": { "type": "string", @@ -25296,7 +23392,7 @@ }, "required": ["data"] }, - "V2DeployWorkerRequest": { + "V2DeployComputeInstanceRequest": { "type": "object", "properties": { "data": { @@ -25305,7 +23401,7 @@ "type": { "type": "string", "description": "Resource type.", - "enum": ["project_worker"] + "enum": ["project_compute_instance"] }, "attributes": { "type": "object", @@ -25490,7 +23586,7 @@ "properties": { "role": { "type": "string", - "enum": ["owner", "administrator", "developer", "read-only"], + "enum": ["owner", "administrator", "developer", "read-only", "no-access"], "description": "Role name to assign. Must be one of: owner, administrator, developer, read-only. Must be on a Team or Enterprise plan to use the read-only role.", "example": "developer" }, @@ -25626,8 +23722,8 @@ }, "role": { "type": "string", - "enum": ["owner", "administrator", "developer", "read-only"], - "description": "Role name to assign. Must be on a Team or Enterprise plan to use the read-only role.", + "enum": ["owner", "administrator", "developer", "read-only", "no-access"], + "description": "Role name to assign. Must be on an Enterprise plan to use the read-only or no-access roles. no-access grants no project visibility until project-scoped roles are assigned separately.", "example": "developer" }, "projects": {