Commit Graph
49 Commits
Author SHA1 Message Date
973bacf783 docs: Data API IA (#42417)
*Summary*
- reorganize the navigation menu to highlight modules, consolidate API
security content, and move guide entries (auto-generated docs, type
generation, security topics) to the intended sections
- relocate the Data API hardening and custom claims RBAC guides into the
API subtree, updating internal references and redirects, and fixing
cross-links (including adjusting the Security reference order)
- adjust data API topic references (e.g., securing guide and role
management) to point to the new paths and ensure the helper link
ordering follows the requested layout

*Testing*
- Not run (not requested)

Change 1

<img width="1286" height="576" alt="image"
src="https://github.com/user-attachments/assets/d903e9b0-bbfc-403f-bcb9-eee540e466db"
/>

Change 2

<img width="1176" height="666" alt="image"
src="https://github.com/user-attachments/assets/82b3ea4c-b8d4-4cb9-ad90-6c39c8a1a997"
/>


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

## Summary by CodeRabbit

* **Documentation**
* Reorganized API documentation structure, consolidating REST and
GraphQL API guides under a dedicated API section.
* Moved security-related guides to API documentation paths for better
organization.
* Implemented automatic redirects for old documentation links to new
locations.
* Updated navigation menu to reflect the restructured documentation
layout.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-03-11 14:11:26 +01:00
Gergely BatorandChris Chinchilla 64e800c0c1 docs: remove duplicate table assignment in Python generated types example (#42185)
Remove duplicate table assignment using undefined `supabase` variable

## 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?

docs update

## What is the current behavior?

-

## What is the new behavior?

-

## Additional context

-


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

## Summary by CodeRabbit

* **Documentation**
* Simplified the Python API client examples in the generating Python
types guide by removing redundant code assignments, making the
documentation clearer and easier to follow.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-10 15:24:16 +01:00
Chandana Anumula 088fca231d Update auto-generated-docs.mdx to display the new UI (#43373)
## 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?

docs update

## What is the current behavior?

Shows the old UI instructions and video

## What is the new behavior?

Updated with new UI instructions and video

## Additional context

Add any other context or screenshots.
2026-03-04 17:48:05 +05:30
Chris PraasandChris Chinchilla e1b51dff81 added CLI example for generating types with self-hosted instance
Docs Update. Added a example for generating types with self-hosted
instance.

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-26 12:20:29 +01:00
Yogeshwaran C 647ac43c0a fix: correct indefinite article usage for acronyms (an HTTP, an API, an RLS) (#42919)
## What kind of change does this PR introduce?

Grammar corrections across documentation and test descriptions.

## What is the current behavior?

Multiple docs and test files use "a" before acronyms that start with a
vowel sound when pronounced:
- "a HTTP" (pronounced "aitch-tee-tee-pee") should be "an HTTP"
- "a API" (pronounced "ay-pee-eye") should be "an API"  
- "a RLS" (pronounced "arr-ell-ess") should be "an RLS"
- "the all users" is redundant (should be "all users")

## What is the new behavior?

All instances corrected to use proper English indefinite articles:

### Docs files (11 files):
- `firebase-auth.mdx` — "the all users" -> "all users" (2 occurrences)
- `log-drains.mdx` — "a HTTP drain" -> "an HTTP drain"
- `securing-your-api.mdx` — "a HTTP 402" and "a HTTP 420" -> "an HTTP"
- `scan-error-*.mdx` — "a HTTP 500" -> "an HTTP 500"
- `roboflow.mdx` — "a HTTP interface" -> "an HTTP interface"
- `auth-hooks.mdx` — "A HTTP Hook" -> "An HTTP Hook", "a HTTP hook" ->
"an HTTP hook", "a HTTP error" -> "an HTTP error"
- `auth-mfa.mdx` — "a HTTP 401" -> "an HTTP 401"
- `password-verification-hook.mdx` — "a HTTP request" -> "an HTTP
request"
- `before-user-created-hook.mdx` — "a HTTP implementation" -> "an HTTP
implementation"
- `pgtap-extended.mdx` — "a API exposed schema" -> "an API exposed
schema"
- `error-codes.mdx` — "a RLS policy" -> "an RLS policy"
- `broadcast.mdx` — "a RLS" -> "an RLS"

### Studio files (1 file):
- `CronJobs.utils.test.ts` — "a HTTP request" -> "an HTTP request" (9
test descriptions) + "notationa" typo -> "notation"

## Additional context

The rule: use "an" before acronyms pronounced with a leading vowel
sound. "HTTP" starts with "aitch" (vowel sound), "API" starts with "ay"
(vowel sound), and "RLS" starts with "arr" (vowel sound).
2026-02-19 07:23:18 -07:00
64b2c52d51 docs: added postgrest error codes (#42369)
## 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?

docs update

## What is the new behavior?

Adds PostgREST mirror codes



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

* **Documentation**
* Added a comprehensive PostgREST Error Codes guide covering database-
and API-level errors, HTTP status mappings, JSON examples, SQL query
samples, and log-analysis/debugging tips.
* Updated REST API Guides navigation to include the new Error Codes
documentation link.
* **Style**
* Expanded spelling allow-list to include "Grantor" (case variant) and
"SQL".
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-02-03 10:50:11 +11:00
Filipe CabaçoandChris Chinchilla 18cabe804b fix(docs): add elixir to client lib docs (#42252)
## 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?

add elixir to client lib docs

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

* **Documentation**
* Added Elixir to the API documentation's community client libraries
list, including a link to the Elixir client repository so Elixir
developers can discover and access the community-supported library.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-29 03:45:14 +00:00
0c4ca45541 chore(docs): add python type gen using CLI guide (#41414)
* chore(docs): add python type gen using CLI guide

* chore: use relative URL instead of absolute one

* chore: add python type gen to docs

* fix: change users to movies

* chore: change .ts to .py

* chore: fix syntax

* Prettier

* fix(docs): instantiate client in the example

* Update apps/docs/content/guides/api/rest/generating-python-types.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-07 10:11:22 -03:00
Filipe Cabaço feecf1f121 docs: add warning regarding db-pre-request usage (#41354) 2025-12-16 10:08:27 +01:00
Chris Chinchilla a3b7c8f3a7 docs: Check and clarify API keys (#41200)
* Update parial

* Add partial to quickstarts

* Auth section

* More

* Prettier

* Realtime

* Add soft links to frameworks

* Add tab

* Fix typo

* More changes

* Updates

* Prettier
2025-12-15 16:45:21 +01:00
Stojan Dimitrovski 34ca04300c feat: make publishable, secret api keys page front-and-center (#40751) 2025-11-24 19:08:00 +01:00
CharisandChris Chinchilla 47705a8968 chore: replace all supabase urls with relative urls (#38537)
* fix: rewrite relative URLs when syncing to GitHub discussion

Relative URLs back to supabse.com won't work in GitHub discussions, so
rewrite them back to absolute URLs starting with https://supabase.com

* fix: replace all supabase urls with relative urls

* chore: add linting for relative urls

* chore: bump linter version

* Prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-09-09 12:54:33 +00:00
Chris ChinchillaandCharis Lam 6821c07811 docs: feature toggle tests (#38282)
* Docs feature toggle tests

* Prettier

* Types fix

* Hide unsupported languages

* Fix import

* Add unsupported code warning

* Further SDK toggling

* Temp intro text

* Auth toggles

* clean up conditional visibility code

* fix: typecheck, tests, tiny bug

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-09-04 16:46:08 +02:00
Terry Sutton ff23c1fe84 fix jwt link (#38016) 2025-08-18 16:02:41 -02:30
Stojan DimitrovskiandChris Chinchilla 93ba2a312c docs: indicate publishable key instead of anon in many examples (#37411)
* docs: indicate publishable key instead of anon in many examples

* replace your-anon-key to string indicating publishable or anon

* fix your_...

* apply suggestion from @ChrisChinchilla

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update keys in code examples

* Prettier fix

* Update apps/docs/content/guides/functions/schedule-functions.mdx

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-18 13:47:48 +02:00
Charis c4d46d5e64 docs: new entry in api keys faq (#37305)
Answering a user question that showed up in feedback
2025-07-18 16:23:08 -04:00
Stojan DimitrovskiandCharis Lam 518d3c278f docs: new api keys (#36331)
* docs: new api keys

* edits

* final touches

* fix suggestions from code review

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-06-17 20:20:32 +02:00
Tyler 8f2993dc0c docs: Add JSON type support for generated typescript types (#36013)
* docs: Add JSON type support for generated typescript types

* run formatter

* update heading format
2025-06-01 20:44:47 +09:00
Kevin Grüneberg c1330d35c0 ci: fix autofix (#34332) 2025-03-22 15:51:01 +01: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
Guilherme Souza fcdf11680a docs: add guide on how to implement retries in supabase-js (#31219) 2025-02-10 19:17:08 -03:00
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Rayhan Ramayudanto 0e75724733 Update Documentation for Accessing Custom Schemas with Data APIs (#32932)
* Update using-custom-schemas.mdx

* Updating the cURL command while keeping the rest of the docs same as before
2025-01-28 20:50:40 +00:00
Charis 572111224b ci(docs): bump linter + expand linting to auth section (#30704) 2024-11-28 10:26:00 -05:00
Lukas 09bd7fc3fe Fix command in documentation for typescript (#30630)
Update generating-types.mdx
2024-11-25 17:39:31 +00:00
GaryAustin1 dce1920ee1 Update securing-your-api.mdx to fix broken example (#30206)
The example for checking additional API keys has a security flaw and bad code.

It checked current_role for anon to do security, but because it is a security definer function the role will never be anon.

Added to check for the role claim in the jwt.

Also the table used for keys is UUID and the type from the header is text for the key.  Cast it to UUID.
2024-10-31 15:46:46 -04:00
Stef KiandFrancesco Sansalvadore 3dabfdb757 Update api-keys.mdx - similarity -> similarly (#28700)
Update api-keys.mdx

Co-authored-by: Francesco Sansalvadore <f.sansalvadore@gmail.com>
2024-08-23 13:36:08 +00:00
ViktorTrojan 1fb351f6a7 fix spelling issue from types/supabase to database.types (#28283) 2024-07-31 00:53:36 +00:00
Guilherme Souza f9751c2e13 chore: official supabase-py (#28209) 2024-07-29 08:00:48 -03:00
SalvatoreLa ba52e2affe Update generating-types.mdx (#28126)
Command "typescript" is deprecated, use "gen types --lang=typescript" instead.
2024-07-24 23:42:01 +00:00
Chris Gwilliams 77529b234b Remove mention of safeupdate temporarily (#28013)
remove mention of safeupdate temporarily
2024-07-22 11:42:21 +01:00
Trevor Dobbertin 9956f195f5 move code snippet above tip that references it (#27581)
* move code snippet above tip that references it

* change wording
2024-07-08 19:16:33 +00:00
Charis b50c657e51 chore(docs): add link (#27829) 2024-07-08 13:12:48 -04:00
Charis f4779d4844 refactor: migrate guides to app router (#23101)
Migrate guides to App Router.
2024-07-03 10:25:06 -04:00
hallidayo 247a57dd54 docs - custom schemas (#27365)
* update to custom schemas doc

* prettier

* upper case sql
2024-06-19 04:23:18 +00:00
Tyler b4e3f47008 docs: Add Flutter / Dart sample codes into the guides. (#27106)
* docs: Adds Dart sample code into using custom schemas guide

* Add Flutter code to OAuth docs

* docs: Add sign out Flutter code to the OAuth guides

* Add Flutter code samples to the auth guides

* docs: Add Flutter code samples to storage docs

* docs: align all Flutter sample code to say Flutter instead of Dart

* docs: sort clean up Flutter and Dart labels

* docs: minor sample code fix

* run prettier
2024-06-11 14:05:52 +09:00
eecff51ecf docs: Added missing dashboard generated types alternative (#26961)
* Add section on generating types from Supabase dashboard

* Added whitespace

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

---------

Co-authored-by: Terry Sutton <saltcod@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-06-04 03:20:44 +00:00
Francesco Sansalvadore 511e7c728c docs: fix broken links (#26711)
* fix rest api docs nav links

* remove unused data-apis page
2024-05-24 11:09:11 +02:00
Greg RichardsonandCharis 3f1df65bba SQL to REST translator (#25978)
* feat: sql-to-rest poc

* feat: sql-to-supabase-js poc

* chore: upgrade to libpg-query@15

* feat: sql-to-rest docs tool

* docs(sql-to-rest): add introduction

* docs: wording improvements

* fix: theme

* chore: tailwind placeholder

* feat(sql-to-rest): limit, offset, and range

* feat(sql-to-rest): sort by

* fix(sql-to-rest): ui theme

* feat(sql-to-rest): casts

* feat(sql-to-rest): dynamic faqs in ui

* feat(sql-to-rest): improve ui responsiveness

* feat(sql-to-rest): more advanced faqs in ui

* feat(sql-to-rest): http and curl syntax highlighting

* feat(sql-to-rest): baseUrl in http/curl rendering

* docs(sql-to-rest): clarification on curl flags

* feat(sql-to-rest): more faqs

* refactor(sql-to-rest): split faqs into own file

* refactor(sql-to-rest): move formatters to sql-to-rest package

* docs(sql-to-rest): move page to new tools section

* feat(sql-to-rest): joins and resource embeddings

* chore(sql-to-rest): rename 'convert' to 'translate'

* feat(sql-to-rest): add faqs

* feat(sql-to-rest): ui improvements

* feat(sql-to-rest): faq title adjustment

* feat(sql-to-rest): link to client lib docs

* feat(sql-to-rest): assumptions

* feat(sql-to-rest): friendly 'not supported yet' errors

* feat(sql-to-rest): json columns

* feat(sql-to-rest): remove curl -G flag if unused

* feat(sql-to-rest): better error handling

* chore: revert accidental rls ai work

* fix: build errors

* fix(sql-to-rest): theme

* feat(sql-to-rest): change base url

* feat(sql-to-rest): basic aggregate poc

* feat(sql-to-rest): group by

* feat(sql-to-rest): more group by checks

* feat(sql-to-rest): count(*) special case

* fix(sql-to-rest): tests

* feat(sql-to-rest): faq on 'and' operator

* fix(sql-to-rest): error messages

* fix(sql-to-rest): multiple filters on same column

* refactor(sql-to-rest): error hints

* feat(sql-to-rest): match and imatch

* feat(sql-to-rest): in operator

* feat(sql-to-rest): parsing error hints

* feat(sql-to-rest): default language to curl

* feat(sql-to-rest): format on cmd+s

* feat(sql-to-rest): format initial value

* fix(sql-to-rest): turn off tab query group

* feat(sql-to-rest): improve wording in error messages

* feat(sql-to-rest): animated code blocks

* feat(sql-to-rest): more error hints

* fix(sql-to-rest): strip primary relation prefix from columns

* feat(sql-to-rest): json column in order by clause

* feat(sql-to-rest): validate all referenced relations exist in from clause

* refactor(sql-to-rest): split core sql-to-rest lib into separate repo

* feat(sql-to-rest): upgrade to v0.1.1

* feat(sql-to-rest): upgrade to v0.1.2

* feat(sql-to-rest): upgrade to v0.1.4

* chore: upgrade libpg-query

* feat: update 'create a pr' link

* fix: app builds

* fix: prettier

* fix: typecheck

* fix: studio tests

* chore: remove console.log

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

* docs(sql-to-rest): remove broken link to client libraries

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-22 12:37:01 -06:00
H0onnnandCharis 3a8369d899 Docs Add Supabase project initialization step (#26594)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-22 00:33:50 +00:00
ec86bbc4fe feat: new auth ia (#22812)
Co-authored-by: Kang Ming <kang.ming1996@gmail.com>
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>
2024-05-07 20:15:06 +00:00
Liam Birkin 73c5826a49 fix: updated url for some docs links that were throwing 404 page (#23220)
fix 404 links
2024-04-24 15:00:36 +00:00
Charis 7e8c07227b fix: cleanup orphan pages (#23200) 2024-04-23 16:16:57 -04:00
Guilherme Souza c7217582ab chore: official supabase-swift (#22678)
* chore: remove community badge from supabase-swift

* chore: update realtime swift reference

* fix typo

* chore: update swift references

* chore: fix misspelling of behavior
2024-04-16 00:01:01 +10:00
Guilherme Souza 6006619c2a chore(docs): add Swift guides (#22625)
* chore(docs): add Swift guides

* chore(docs): add Swift guides for postgres changes

* chore: fix link identity swift method

* chore(docs): add Swift guides for realtime and storage

* chore: run npm run format

* chore(docs): add Swift example for passing params to `rpc` function
2024-04-10 10:57:27 -04:00
Jacob BowdoinandCharis 69cf45d72e docs: clarify strictNullChecks required for MergeDeep usage (#22012)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-19 08:12:50 +00:00
Charis 922a8f941d fix: update terminology around anonymous vs public/unauthenticated (#21814) 2024-03-07 14:39:07 -05:00
Vojtech NovakandCharis 5302a01c60 docs: mention local option in generating-types.mdx (#21695)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-01 16:18:46 +00:00
Charis b0b8b6b6e3 refactor: finish moving mdx to content directory (#21321) 2024-02-16 13:43:02 -05:00