Commit Graph

83 Commits

Author SHA1 Message Date
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]
af24c397fd docs: update js sdk docs (2.107.0) (#46583)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.107.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-06-02 16:45:59 +02: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]
6e17d85e55 feat: update mgmt api docs (#46045)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-05-18 10:50:44 +02:00
supabase-supabase-autofixer[bot]
d71717585e docs: update js sdk docs (2.105.4) (#45718)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.4`
- **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-08 18:01:36 +03:00
supabase-supabase-autofixer[bot]
b01941275b docs: update js sdk docs (2.105.2) (#45559)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.105.2`
- **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-05 11:07:24 +02:00
supabase-supabase-autofixer[bot]
bf0df280a3 feat: update mgmt api docs (#45497)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-05-04 14:28:16 +02:00
supabase-supabase-autofixer[bot]
7f638a8cd3 docs: update js sdk docs (2.104.1) (#45155)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.104.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-04-23 15:13:04 +01:00
supabase-supabase-autofixer[bot]
154f3eb6cc docs: update js sdk docs (2.104.0) (#45048)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.104.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-04-20 15:12:31 +03:00
supabase-supabase-autofixer[bot]
4a3592f373 feat: update mgmt api docs (#45027)
This PR updates mgmt api docs automatically.

Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-04-20 09:19:34 +02:00
supabase-supabase-autofixer[bot]
ea15a7b8b9 docs: update js sdk docs (v2.103.3) (#44944)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `v2.103.3`
- **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-16 17:24:51 +02:00
supabase-supabase-autofixer[bot]
667d1ce497 docs: update js sdk docs (2.103.1) (#44890)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.103.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-04-15 11:39:20 +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]
0cfc038d7d docs: update js sdk docs (2.101.1) (#44400)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.101.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-04-01 11:35:51 +02:00
supabase-supabase-autofixer[bot]
76efd06a96 docs: update js sdk docs (2.101.0) (#44348)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.101.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-03-30 19:04:40 +03:00
supabase-supabase-autofixer[bot]
d58cc5b157 docs: update js sdk docs (2.100.1) (#44236)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.100.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-03-27 11:39:52 +01:00
Katerina Skroumpelou
b87f6fa056 docs: move the rest of the docs to the js repo (#44096)
Ref PR: https://github.com/supabase/supabase-js/pull/2165

Remove entries from yaml. Use `tsdoc` only.
2026-03-26 14:29:50 +02: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
Katerina Skroumpelou
49df02ce91 docs: move postgrest-js and realtime-js docs to tsdoc (#43908)
* Move postgrest-js docs to tsdoc
(https://github.com/supabase/supabase-js/pull/2177)
* Move realtime-js docs to tsdoc
(https://github.com/supabase/supabase-js/pull/2164)
* Remove entries from yml
2026-03-23 14:35:40 +02:00
supabase-supabase-autofixer[bot]
05252ff8cb docs: update js sdk docs (2.99.1) (#43684)
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.

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

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

Manual: also clean up yml

---------

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2026-03-12 09:11:05 +02:00
supabase-supabase-autofixer[bot]
2a30411dc2 docs: update js sdk docs (2.99.0) (#43553)
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `2.99.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-03-09 16:01:02 +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]
4b388b7bf7 docs: update js sdk docs (v2.94.1) (#42454)
Updates JS sdk documentation following stable release. 
Ran `make` in apps/docs/spec to regenerate tsdoc files.

**Details:**
- **Version:** `v2.94.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>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2026-02-04 18:39:59 +02: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
supabase-supabase-autofixer[bot]
2a8d5bbe73 docs: update js sdk docs (2.91.1) (#42104)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-01-23 16:02:16 +02:00
github-actions[bot]
43bf244f3a feat: update mgmt api docs (#41146)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2026-01-13 10:57:25 +07:00
Katerina Skroumpelou
69c9104702 docs: update js client libraries (2.90.0) (#41764)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2026-01-07 14:31:07 +02:00
github-actions[bot]
d7e1d07aae docs: update js client libraries (2.88.0) (#41404)
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
2025-12-17 16:17:21 +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]
fc32d0c667 docs: update js client libraries (2.85.0) (#40839)
Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
2025-11-26 16:16:09 +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
Katerina Skroumpelou
2e64be1463 docs: vector bucket and vector analytics js docs (#40467)
* docs: update js client libraries (2.83.0)

* docs: vector buckets and analytics js docs

---------

Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
2025-11-18 17:42:08 +02:00
github-actions[bot]
1f48110140 docs: update js client libraries to latest docs with extra examples (#40517)
docs: update js client libraries (2.81.1-extra.0)

Co-authored-by: mandarini <6603745+mandarini@users.noreply.github.com>
2025-11-17 13:47:04 +00: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
github-actions[bot]
cd20c43f50 feat: update mgmt api docs (#38902)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
Co-authored-by: Raúl Barroso <code@raulb.dev>
2025-09-22 15:38:10 +00:00
Stojan Dimitrovski
e8c158bc48 docs: web3 and some other js reference improvements (#38670)
* docs: web3 and some other js reference improvements

* add MetaMask to spell rules

* apply suggestion from @cemalkilic

Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>

* fix tests

* test: update snapshot

---------

Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-15 14:56:34 +02: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
github-actions[bot]
de80626671 feat: update mgmt api docs (#37652)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2025-08-04 20:24:33 +00:00
Katerina Skroumpelou
f6585d18d3 chore: update storage js docs (#37515) 2025-07-31 12:43:34 +00: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
github-actions[bot]
27af144426 feat: update mgmt api docs (#34554)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-03-31 15:29:20 +00:00
github-actions[bot]
0ad3412d7a feat: update mgmt api docs (#34365)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2025-03-27 18:53:51 +00:00
github-actions[bot]
99a3a3f557 feat: update mgmt api docs (#33950)
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com>
2025-03-17 15:43:36 +00:00
Charis
c5c5bc231f feat: support typedoc 0.27 (#33905)
Type docs pulled from JS client libraries were expected to be in version 0.22, which unfortunately is a bit old and incompatible with TypeScript 5. Therefore any JS lib that upgrades their toolchian to TS 5 will inadvertently break their type specs in docs.

This PR updates docs to also support 0.27 (the latest stable version, compatible with TS 5), in addition to the old version. Parallel support is required since many libs are still on the old version.

The main changes are:
- The comment shape has changed in typedoc.
- kindString has been deprecated in favor the kind numbers.
- indexSignatures are now plural (an array).
2025-03-03 17:17:38 +00:00
Andrew Valleteau
ac54d858a1 chore(docs): setup docs for overrideTypes (#33705)
* chore(docs): setup docs for overrideTypes

* fix: add overrideTypes to docs section

* chore: regen specs

* chore: update snapshot

* chore: regenerate all specs

* revert realtime spec changes

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-03-03 15:35:39 +01:00