Commit Graph
264 Commits
Author SHA1 Message Date
Charis a99f86cd67 docs: remove supabase-js release notes (#37772)
Remove the Release Notes section from the JS reference docs, since no
one maintains them.
2025-08-08 10:21:41 -04:00
github-actions[bot]andphamhieu 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
Srinivas AandCharis a8b254f0ef docs: enhance verifyOtp() and resend() method description with detailed verification types (#37339)
* docs: enhance verifyOtp() method description with detailed verification types and examples

* Update apps/docs/spec/supabase_js_v2.yml

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-08-04 16:10:30 -04:00
Copple 952698e6e6 chore: update cli reference doc (#37343)
* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc

* chore: update cli reference doc
2025-08-02 11:25:24 -04:00
Katerina Skroumpelou f6585d18d3 chore: update storage js docs (#37515) 2025-07-31 12:43:34 +00:00
github-actions[bot]andkamilogorek 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
Jan Tennert cfedfc974a docs: update Kotlin docs (#36718)
* update kotlin docs

* fix typo
2025-07-15 13:31:28 +00:00
CoppleandHan Qiao 203b998780 chore: update cli reference doc (#37142)
* chore: update cli reference doc

* Apply suggestion from @sweatybridge

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2025-07-15 09:49:04 +00:00
Charis 1c2312975b docs: add auth getClaims method (#37122) 2025-07-14 21:13:23 +00:00
Vasya Pank-su 5c4662fcc6 docs: Fix type typo in Kotlin docs (#37110) 2025-07-14 15:04:45 +00:00
Andrew Smith 298bcc535c docs(python): add params to the update_user method (#36871) 2025-07-10 15:06:34 +00:00
Beng Eu 6504a8460f chore: enable prettier cache, speeds up subsequent runs ~6.5x (#37005) 2025-07-10 20:32:12 +08:00
Chemsdine 9ec32d68df Changed -an List- to -a List- (#36856)
* Changed -an List- to -a List-

* Changed an List to an array
2025-07-04 15:19:29 +00:00
Copple b8193041ea chore: update cli reference doc (#36790) 2025-07-02 19:18:40 -04:00
Aman Pal 699d53e087 docs: update documentation for issue #36705 (#36716) 2025-06-27 18:50:50 +00:00
Gaurav Deep 6d728885d3 docs: fix RPC example for parameterless calls by adding undefined (#36714)
docs: fix RPC example when using options for parameterless call (#36713)
2025-06-26 16:21:20 +00:00
Copple 985304e5ed chore: update cli reference doc (#36454) 2025-06-17 13:58:20 -04:00
Ziinc 671aea0a4a fix: use LOGFLARE_PRIVATE_ACCESS_TOKEN for querying, LOGFLARE_PUBLIC_… (#36169)
* fix: use LOGFLARE_PRIVATE_ACCESS_TOKEN for querying, LOGFLARE_PUBLIC_ACCESS_TOKEN for ingestion

* chore: prettier

* chore: remove logging

* chore: remove unused import
2025-06-05 14:52:29 +08:00
Charis cf3ecc93eb chore(docs): turn on strictNullChecks (#36180)
strictNullChecks was off for docs, which lets errors slip through and
leads to incorrect required/optional typing on Zod-inferred types. This
PR enables strictNullChecks and fixes all the existing violations.
2025-06-04 17:05:37 -04:00
Copple ade0e400fa chore: update cli reference doc (#36126) 2025-06-03 11:59:03 +08:00
Lawrence Wang 069c899168 Improve supabase link documentation (#36083)
Show that its setting is persisted in the filesystem at `supabase/.temp/project_ref`, so developers have a way of seeing what project is currently linked. 

This appears to be otherwise undocumented, and only mentioned in one Github issue and one Reddit comment as far as I can tell.
2025-06-02 15:46:49 +00:00
Andrew Smith a2342c4207 docs(python): update realtime docs with async methods and notes (#36015)
* docs(python): update realtime docs with async methods and notes

* chore(docs): update with admonitions
2025-05-29 15:45:54 +00:00
Hieu Vu 60d9202bdd Docs: Improve chip text in Dart and Kotlin examples (#35740)
Improve chip text in dart and kotlin examples
2025-05-20 16:02:59 +00:00
Copple 5bc5af2b47 chore: update cli reference doc (#35765) 2025-05-20 11:55:16 +08:00
Ofir Levitan 2f475ae9f9 remove dart invoke example that's not relevant (#35672)
removed example
2025-05-15 15:09:04 +00:00
Andrew Smith c621403b93 fix(docs): update invalid redirect urls link in ref docs (#35646) 2025-05-13 13:52:21 +00:00
Nico Kempe 3fcc5538b7 docs(auth-js): add nonce usage note to reauthenticate() docs (#35206)
docs(auth-js): include reminder to pass OTP as nonce in updateUser()

Add one‑liner on using the received OTP as the `nonce` in updateUser()
2025-05-06 23:27:36 +00:00
Copple 22ee5dfe2a chore: update cli reference doc (#35490) 2025-05-06 12:11:42 -04:00
Tyler 7bf04545d8 docs: Add some missing descriptions to the CLI reference docs (#35434)
* Add description for supabase-config-push

* docs: Add descriptions to a few cli commands and command groups

* delete the unnecessary note about linking a project

* fix/add cli-latest file to gitignore
2025-05-04 09:28:35 +09:00
Copple 9227e83e56 chore: update cli reference doc (#35258) 2025-04-25 02:37:13 +08:00
Copple e2e3449ff8 chore: update cli reference doc (#35193) 2025-04-22 12:31:10 +08:00
bnlvn 4f2c9e5c45 docs:Clarify behavior of email confirmation during email updates (#35150)
Updated the email update note in the docs to explain that confirmation emails are still sent due to the Secure Email Change setting. Added a direct link to the relevant dashboard setting to help users better understand and manage the behavior.
2025-04-21 13:02:41 +00:00
bnlvn 68fde6cf84 docs(auth): clarify mapping of user metadata in updateUser example (#35047)
Adds a note explaining that the `data` field maps to `raw_user_meta_data` in the database,
and is returned as `user_metadata` when calling `getUser()`.
2025-04-17 00:16:35 +00:00
Copple 3e702e4dc1 chore: update cli reference doc (#34824) 2025-04-08 12:33:17 -04:00
Ivan Vasilov cb2889462e chore: Bump redocly/cli to get updated versions of redoc and dompurify (#34656)
* Bump redocly/cli to bump redoc and dompurify.

* Regenerate spec files.
2025-04-02 17:46:03 +08:00
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]andphamhieu 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
Copple c5579df01d chore: update cli reference doc (#34443) 2025-03-26 16:04:23 -04:00
Copple 065cc37928 chore: update cli reference doc (#34399) 2025-03-25 08:46:09 +01:00
github-actions[bot]andphamhieu 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
Copple b74cf6abe7 chore: update cli reference doc (#34184) 2025-03-13 17:22:51 +00:00
Copple 1b31e472fb chore: update cli reference doc (#34160) 2025-03-12 21:58:51 +00:00
Copple 0d6440b5cb chore: update cli reference doc (#34127) 2025-03-12 00:40:41 +08:00
Charis 60f53d4b2a fix(docs): example (#34088)
Example returns incorrect data.
2025-03-10 10:25:34 +01:00
Andrew Valleteau a683bfdc7a feat(docs): document ratelimits configurations (#33830)
* feat(docs): document ratelimits configurations

* chore: fix fields name

* chore: update auth.rate_limit api
2025-03-06 20:16:19 +08: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 ValleteauandCharis Lam 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
Chris Gwilliams e9017ba39a add inspect report to cli docs (#33815) 2025-02-25 08:24:30 +02:00
Copple cb80fbc628 chore: update cli reference doc (#33827) 2025-02-25 10:24:04 +08:00
Teng Wei Herr dd3a9b5e09 docs(supabase-js): add example to clarify how to fetch data with spaces in table name (#33443)
* docs: add supabase-js example with spaces in table names

* update copy and example
2025-02-24 17:50:08 +00:00