41 Commits

Author SHA1 Message Date
Gildas Garcia 9b1dddde11 Scoped PAT: add api_gateway_keys_secret_read and data_api_config_secret_read permissions (#50134)
## What kind of change does this PR introduce?

Surface the new scoped personal access token permissions published in
`@supabase/shared-types` 0.1.95 (added by
https://github.com/supabase/platform/pull/38060, now deployed).

**Stacked on #50234**, which regenerates the Management API types so
Studio's scope type includes the new ids. This PR targets that branch
and will retarget to `master` when it merges.

## What's in here

- Bump `@supabase/shared-types` to 0.1.95 (Studio and shared-data).
- Catalog entries in
`packages/shared-data/scoped-access-token-permissions.ts`:
- **API Key Secrets** (`api_gateway_keys_secret_read`): gates
`?reveal=true` on the API keys endpoints. Renamed from "JWT secret",
which described the wrong thing.
- **Data API JWT Secret** (`data_api_config_secret_read`): gates the
`jwt_secret` field on the PostgREST config endpoint.
- **Compute** (`workers_read` / `workers_write`): shared-types 0.1.95
also publishes the workers scopes, so they surface in the catalog now.
Named to match Studio's product naming (#50208).
- Minimum roles for the four new ids in `FGA_SCOPE_MINIMUM_ROLE`,
transcribed from the OpenFGA model (secret reads: developer; workers
read: readonly; workers write: developer).
- Docs generator (`generateAccessControlPartials.mts`):
  - Drop the workers exclusion now that the scopes are live.
- When an endpoint lists alternative permission sets (for example API
keys read alone, or read plus secret read for reveal), a row's footnote
now only considers the alternatives that include that row's own scope.
Previously the API Key Secrets row would have said "Requires API Keys
(Read), or API Keys (Read) and API Key Secrets (Read)".
- Regenerated PAT guide tables. The committed Management API specs
predate the secret scopes, so this also includes the same spec refresh
the weekly docs bot performs (`chore(docs): refresh the Management API
specs`, kept as its own commit). Besides the new rows it picks up two
new upstream endpoints under Advisors and the branch rows.

## Verified

- `pnpm --filter studio typecheck` clean on top of #50234.
- Access token test suite passes, including the guard that the role
table covers exactly the ids shared-types publishes.
- Partial regeneration is idempotent, so the Docs Tests stale-table gate
passes.

## Follow-ups (not in this PR)

- `apps/docs/content/guides/getting-started/api-keys.mdx` says a
fine-grained token needs `api_gateway_keys_read` for the `?reveal=true`
example. It now also needs `api_gateway_keys_secret_read`.
- `project:api_gateway_keys` still says "Read exposes API keys" in its
risk reason, which overstates it now that secret values sit behind a
separate scope. Rewording may mean revisiting its risk level.
- The comment in `ComputeLayout.tsx` about shared-types not exposing
`workers_read` is stale.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added permission support for API key secrets, Data API JWT secrets,
and compute workers.
  * Added API endpoints to run project advisors and create branches.
* Added support for additional log-drain destinations, including S3,
Last9, and OTLP.
* Added storage object versioning information to project configuration
responses.
* **Documentation**
* Updated access-control documentation for new permissions, worker
operations, advisor runs, and branch creation.
  * Clarified Data API configuration and secret descriptions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-09-11 13:31:21 +08:00
supabase-supabase-autofixer[bot] b9a4b3fa53 feat: update mgmt api docs (#49128)
This PR updates mgmt api docs automatically.

Co-authored-by: samirketema <6003000+samirketema@users.noreply.github.com>
2026-08-26 10:01:47 -07:00
supabase-supabase-autofixer[bot] cd4223e128 feat: update mgmt api docs (#48628)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-08-11 18:12:57 -06:00
Ali Waseem 9b51678fcf Revert "feat: update mgmt api docs (#48282)" (#48545)
## What kind of change does this PR introduce?

Revert

## What is the current behavior?

#48282 auto-updated the mgmt API docs spec files
(`apps/docs/spec/api_v1_openapi.json`,
`apps/docs/spec/api_v2_openapi.json`,
`apps/docs/spec/common-api-sections.json`, and the deparsed transform
files).

## What is the new behavior?

Reverts those spec/transform files back to their state prior to #48282.

This reverts commit 4adef69037.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated API reference documentation with clearer authorization
requirements and more accurate request and response schemas.
* Improved validation details, examples, required fields, and response
variations across projects, authentication, storage, backups, SSO,
analytics, and functions.
* Documented separate paginated listing and count operations for action
runs.
* Added clearer JIT response definitions and refined API behavior
descriptions.
* Removed documentation entries for several retired analytics,
organization, invitation, and private-link operations.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-31 09:19:18 -06:00
supabase-supabase-autofixer[bot] 4adef69037 feat: update mgmt api docs (#48282)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-07-31 07:49:45 -06:00
supabase-supabase-autofixer[bot] 1bdef68074 feat: update mgmt api docs (#47622)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-07-06 08:15:51 +02:00
supabase-supabase-autofixer[bot] eb21ae25f7 feat: update mgmt api docs (#47382)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-06-29 10:15:50 +02:00
supabase-supabase-autofixer[bot] 7d4ec098ea feat: update mgmt api docs (#46955)
This PR updates mgmt api docs automatically.

Co-authored-by: jbergstroem <176984+jbergstroem@users.noreply.github.com>
2026-06-16 09:22:42 +02:00
Hieu 4ff4cdc62d feat: expose mgmt api v2 spec on official document (#46605)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Include the v2 mgmt API spec in the official docs. This PR merges the v1
and v2 specs when generating the reference, with v2 taking precedence on
conflicts.

Fixes API-1215

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Docs now include API v2 reference: log-drain management
(list/create/update/delete) and project transfer (preview/transfer).

* **Documentation**
* Generated API reference now merges v1 and v2 specs so both appear in
the docs and section listings.
* New v2 operations added to Analytics and Projects documentation
sections.

* **Chores**
* Docs generation pipeline updated to accept and process multiple API
spec inputs.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-04 14:53:26 +07:00
supabase-supabase-autofixer[bot] 4972359033 docs: update js sdk docs (2.106.1) (#46155)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.106.1`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-05-21 10:11:29 +02:00
supabase-supabase-autofixer[bot] 4a41db591f docs: update js sdk docs (2.102.1) (#44626)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.102.1`
- **Source:** `manual`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
2026-04-07 17:48:58 +03:00
supabase-supabase-autofixer[bot] f04bcf07d5 docs: update js sdk docs (2.100.0) (#44078)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.100.0`
- **Source:** `manual`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
2026-03-23 15:52:48 +02:00
supabase-supabase-autofixer[bot] 73b829c2cd docs: update js sdk docs (2.98.0) (#43213)
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.98.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-02-27 11:04:51 +01:00
supabase-supabase-autofixer[bot] 3a5fd59a12 docs: update js sdk docs (2.96.0) (#42946)
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.96.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-02-17 17:12:18 +01:00
supabase-supabase-autofixer[bot] f580b4014b docs: update js sdk docs (2.94.0) (#42414)
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.94.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files

🤖 Auto-generated from @supabase/supabase-js stable release.

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-02-03 18:01:31 +02:00
supabase-supabase-autofixer[bot] 2db3e73911 docs: update js sdk docs (2.93.0) (#42165)
* docs: update js sdk docs (2.93.0)

* docs: fix references for javascript typespec

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2026-01-26 17:58:54 +00:00
github-actions[bot] 0243d7ebf3 docs: update js client libraries (2.87.0) (#41161)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2025-12-09 11:30:41 +00:00
github-actions[bot] a0e62693aa docs: update js client libraries (patch) (#40779)
* docs: update js client libraries (patch)

* docs(storage): update sections and navmenu

* docs: fix broken links in runtime

* docs: update examples

* docs: update snapshot

* docs: fix type return

* docs: updated return and snaps

* docs: fix some rendering reference issues

* docs: surface types

* docs: update examples

* docs: update snapshot

* docs: remove script for gaps analysis

---------

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2025-11-26 15:51:02 +02:00
github-actions[bot] 8c326ebf9d docs: update js client libraries (2.81.1) (#40359)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2025-11-13 10:08:25 +00:00
github-actions[bot] 6d9176187e docs: update js client libraries (2.78.0) (#40013)
* docs: update js client libraries (2.78.0)

* fix(docs): add fallback for unhandled schema types in API reference

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2025-10-31 13:22:10 +02:00
github-actions[bot] ea25aa5106 docs: update js client libraries (v2.75.1) (#39620)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-10-17 15:00:43 +00:00
Katerina Skroumpelou b7f1616e3c chore: update docs from js monorepo (#39200)
* chore: update docs from js monorepo

* chore: remove sparse-checkout for workflow to work

* chore: update workflow with no-frozen-lockfile

* chore(js libs docs update): regenerate typespec snapshot on update

* fix(typespec): fix missing types in transformed typespec

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-10-03 12:02:53 +03:00
Katerina Skroumpelou a5fc052704 docs: update js client libs docs (#38595)
* docs: update js client libs docs

* chore: update test snapshot for specs

* ci(docs): run tests on spec changes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-11 12:14:27 +01:00
Kamil Ogórek 29ab42957a ref(docs): Respect x-internal openapi spec attribute (#38255) 2025-09-03 18:46:48 -04:00
github-actions[bot] f1753e7dc2 feat: update mgmt api docs (#37455)
Co-authored-by: kamilogorek <1523305+kamilogorek@users.noreply.github.com>
2025-07-25 09:44:38 +02:00
Charis 1c2312975b docs: add auth getClaims method (#37122) 2025-07-14 21:13:23 +00:00
github-actions[bot] bf04ff6681 feat: update mgmt api docs (#33642)
Co-authored-by: kamilogorek <1523305+kamilogorek@users.noreply.github.com>
2025-02-19 09:30:58 +00:00
Kamil Ogórek a67fcb1809 docs: Regenerate specs for all API docs references (#33265)
* docs: Regenerate specs for all API docs references

* Fix the reference docs parsing.

* Update snapshots of docs tests.

* fix(ui): hide details panel for file params

* fix(ui): fix array display when inner type is not given

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-02-04 14:57:17 +01:00
github-actions[bot] 7a0871b9ce feat: update mgmt api docs (#32732)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2025-01-13 19:10:31 +00:00
github-actions[bot] eb326ea75a feat: update mgmt api docs (#31092)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-12-12 15:40:26 +00:00
github-actions[bot] 3d63cfe2b1 feat: update mgmt api docs (#30252)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-11-04 19:04:48 +00:00
github-actions[bot] e1fb0cc719 feat: update mgmt api docs (#30000)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-10-28 22:58:13 +00:00
github-actions[bot] b438f1001f feat: update mgmt api docs (#29869)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-10-16 15:56:26 +00:00
github-actions[bot] 55bdda2401 feat: update mgmt api docs (#29708)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-10-08 20:58:24 +00:00
Ivan Vasilov b0cf2bf6fa chore: Move parser package to packages folder (#29522)
* Move the spec/parser package into packages folder.

* Fix the spec generation with the new paths.

* Remove the spec folder from prettierignore.

* Run prettier on the spec folder (without regenerating, that's should be done by the product teams).
2024-09-25 23:45:14 +02:00
github-actions[bot] 90b71e3e42 feat: update mgmt api docs (#27958)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-07-15 19:01:26 +00:00
github-actions[bot] 8aef4a08bf feat: update mgmt api docs (#27851)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-07-08 19:13:11 +00:00
github-actions[bot] 8d9dda6d12 feat: update mgmt api docs (#26987)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2024-06-10 22:25:03 +00:00
Hieu d855bfb3f8 feat: automate mgmt api spec update (#26655)
* fix: correct mgmt api naming

* feat: new command to generate mgmt api sections

* feat: sort section items

* chore: tidy up

* fix: add generate sections to the default command

* feat: add gha to auto update mgmt api docs

* chore: tidy up

* fix: operationId logic to support self-hosting references

* chore: update latest mgmt api specs

* chore: update latest mgmt api specs
2024-05-31 08:53:19 +07:00
Hieu c5a88a9fc4 feat: render mgmt api body params (#26319)
* feat: render body parameters

* feat: api parameters render

* fix: update mgmt api spec to latest

* fix: body param format and support content type selection

* fix: prettier errors

* fix: use Options to render accepted enum values

* fix: prettier again

* fix: merge conflict

* fix: expose new api routes

* fix: prettier again

* refactor: ApiBodyParam

* fix: add missing apis

* chore: tidy up

* feat: improve api response with sample + schema tabs

* fix: support show/hide object param schema

* fix: show no content text

* refactor: use collapsible for hidden content

* Update apps/docs/components/reference/ApiOperationSection.tsx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/components/ApiSchemaOption.tsx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* fix: resolve comments

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-05-21 13:30:34 +07:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00