Commit Graph
42 Commits
Author SHA1 Message Date
Guilherme SouzaandClaude Opus 4.6 32f70db13d docs: Update documentation from SDK changes (Jan 22 - Feb 16) (#42874)
## Summary

This PR updates documentation based on recent changes across multiple
SDK repositories since the last run on 2026-01-22.

## Changes Analyzed

| SDK | Repository | Commits | Latest Tag |
|-----|-----------|---------|------------|
| **js** | supabase/supabase-js | 40 | v2.95.4-canary.2 |
| **dart** | supabase/supabase-flutter | 4 | - |
| **py** | supabase/supabase-py | 12 | v2.28.0 |
| **swift** | supabase/supabase-swift | 14 | v2.41.1 |
| **kt** | supabase-community/supabase-kt | 36 | 3.3.0 |
| **csharp** | supabase-community/supabase-csharp | 1 | v1.1.2 |

## Documentation Updates

### JavaScript SDK (`supabase_js_v2.yml`)
- Added optional `jwt` parameter documentation to
`mfa.getAuthenticatorAssuranceLevel()`
- Added `timeout` and `urlLengthLimit` options to `PostgrestClient`
constructor with example

### Kotlin SDK (`supabase_kt_v3.yml`)
- Added new `getClaims()` API section with description, parameters, and
3 examples
- Added `channel` parameter to OTP `signInWith` config for WhatsApp
support
- Added WhatsApp OTP sign-in example

### Python SDK (`supabase_py_v2.yml`)
- Added `from_.list_v2()` method documentation with cursor-based
pagination support
- Includes `SearchV2Options` parameter documentation and pagination
example
- Added note about new User model fields (`is_sso_user`, `deleted_at`,
`banned_until`) on `get_user`

### Swift SDK (`supabase_swift_v2.yml`)
- Added breaking change note for `mfa.unenroll()`: response now uses
`id` instead of `factorId` (since v2.41.1)

### Phone Login Guide (`phone-login.mdx`)
- Added Kotlin WhatsApp OTP example to the sign-in section

### SDKs with no documentation updates needed
- **Dart**: Only CI and realtime type-cast fix (no user-facing API
changes)
- **C#**: Only README badge fix

## Test plan
- [ ] Verify YAML spec files parse correctly
- [ ] Review rendered documentation for new sections
- [ ] Confirm code examples match actual SDK APIs

---

Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-17 13:48:12 +01:00
Illia BasalaievandIllia Basalaiev 850d4e81c1 Chore: update python client examples (#42334)
## 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?

Please link any relevant issues here.
- Minor grammar fixes
- Delete bulk: countries → characters table name
- Text search: Replaced "fat" with "the", added data sources and
responses for 3 examples
- Or filter: Fixed reponse typo, changed book_id → section_id
- Order modifier: Added missing .execute()
- Link identity: Fixed dict syntax {provider:} → {"provider":}
- Unlink identity: res → response
- List users: Removed trailing comma
- Reauthenticate: updateUser() → update_user()

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

## Summary by CodeRabbit

* **Documentation**
* Enhanced grammar and terminology consistency throughout documentation.
* Improved code examples with standardized formatting, naming
conventions, and accurate references.
* Expanded documentation examples with additional data context and
sample outputs to clarify expected results.

<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: Illia Basalaiev <illiab@IMB3.local>
2026-02-02 23:55:21 +00:00
Danny White 19cf4bb4bf feat(studio): consolidate settings phase 2 (#37612)
* new slugs

* remove symlinks

* rabbit
2026-01-26 15:41:05 +08:00
Peyton NowlinandChris Chinchilla bf250547f6 fix: correct typos across codebase (#41038)
- Fix 'occured' -> 'occurred' in ErrorDetailsButton.tsx

- Fix 'requried' -> 'required' in storage bucket mutations

- Fix 'reponse' -> 'response' in API spec files

- Fix 'localy' -> 'locally' and 'depoy' -> 'deploy' in README

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-15 05:15:18 +00:00
Chris Chinchilla 9cbda3ecdc docs: Fix broken redirects and update SDK references to use more appropriate URLs (#41461)
Fix broken redirects and update SDK references to use more appropriate URLs
2025-12-19 11:17:32 +01:00
Guilherme Souza a40bf4dfa4 docs: Update from supabase-py PRs #1240, #1283, #1318 (#41087)
* docs: Update from supabase-py PRs #1240, #1283, #1318

- Add upsert option to create_signed_upload_url (PR #1283)
- Add vector and analytics bucket methods documentation (PR #1318)
- Add OAuth 2.1 admin endpoints documentation (PR #1240)

All features are marked as alpha and may change in the future.

# Conflicts:
#	apps/docs/spec/supabase_py_v2.yml

* docs: Add Python examples to guides for supabase-py PRs #1240, #1283, #1318

- Add Python examples to vector bucket guides (creating, storing, querying, working with indexes)
- Add Python examples to analytics bucket creation guide
- Add Python examples for OAuth admin endpoints (create_client, list_clients)
- Add Python example for create_signed_upload_url with upsert option

All examples follow existing guide patterns and use proper TabPanel structure.

* style: format guides

* fix: Quote YAML descriptions with backticks to fix parsing error

Fixes YAML parsing error at line 8453 by properly quoting description strings that contain backticks and commas.

* fix(docs): match ids for python reference
2025-12-12 16:48:52 +00:00
Andrew Smith d6051e89f8 docs(python): fix create_signed_upload_url upsert option (#40221) 2025-12-09 07:39:34 +00:00
Katerina Skroumpelouandsupabase-releaser[bot] 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
Guilherme Souza 69e346d430 docs: add max_affected() method to Python client reference (#39128) 2025-10-01 05:09:09 -03:00
Guilherme Souza 2ec278a022 docs: document automatic presence enablement in Python client (#39129) 2025-10-01 05:08:51 -03:00
Chris StocktonandChris Stockton 6a777e1fae fix: small typo in identites -> identities (#38292)
Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
2025-09-03 15:28:47 -07:00
Andrew Smith 61237605c1 docs(python): add get_claims method (#37549) 2025-08-12 18:15:15 +00:00
Charis 1c2312975b docs: add auth getClaims method (#37122) 2025-07-14 21:13:23 +00:00
Andrew Smith 298bcc535c docs(python): add params to the update_user method (#36871) 2025-07-10 15:06:34 +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
Illia BasalaievandIllia Basalaiev 4a225a4642 chore: minor syntaxt and links updates in Python docs (#31146)
* resolve conflicts, improve styling

* standardize code examples

* remove trailing comas

---------

Co-authored-by: Illia Basalaiev <illiab@IMB3.local>
2025-02-19 18:45:40 +01:00
Guilherme Souza dd7da2187d docs: fix param name for storage python method (#33360) 2025-02-05 13:12:53 -03:00
Charis 93885b090f chore: examples (#33183) 2025-01-30 13:08:46 -05:00
Bobbie Soedirgo 1f9af325c2 docs: add example to order parent table by referenced table (#32920)
* docs: add example to order parent table by referenced table

* docs: more ordering by referenced table examples
2025-01-21 15:59:50 +08:00
RaghavgitGroverandCharis ecf62ed0fc docs: clarify language in range documentation (#30989)
* docs: clarify language in range documentation

- Change parameter names from start/end to from/to for consistency
- Fix incorrect offset description in notes section

* Apply suggestions from code review

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-12-09 18:20:30 +00:00
github-actions[bot]andphamhieu 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
Andrew SmithandCharis 531a96aace docs(python): add params and response to storage reference docs (#30105)
* docs(python): add params and response to storage reference docs

* chore: update the download file and copy method

* chore: add additional methods

* Apply suggestions from code review

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

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-11-03 23:15:10 +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
Andrew Smith d523fe344b docs(python): document more auth methods (#29005)
* docs(python): document more auth methods

* chore: add overview and missing auth.admin methods
2024-09-02 12:47:18 -03:00
Andrew SmithandJoel Lee 4664587624 docs(python): add params for sign-in methods (#27639)
* add params for sign-in methods

* Add sign in with id token docs

* add more auth methods docs

* docs(python): remove credentials param name

* Update apps/docs/spec/supabase_py_v2.yml

Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>

* Update apps/docs/spec/supabase_py_v2.yml

Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>

---------

Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com>
2024-08-16 21:41:39 +08:00
Guilherme Souza f2ab50ea45 docs(python): add reference docs for python realtime (#28680)
* docs(python): add reference docs for python realtime

* python realtime guides

* remove $ref
2024-08-16 06:56:51 -03:00
Guilherme Souza 19e1978e5b docs(python): remove wrong params from update method (#28663) 2024-08-15 13:08:36 -04:00
Guilherme Souza 860b8d8a8d docs(python): fix wrong type for on_conflict param (#28637) 2024-08-14 13:17:38 -03:00
Charis fc164b5d07 Refactor/app router refs (#28095)
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.)

Some notes:

Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all.

Tried various tricks with caching and pre-generating data but no dice.

So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages.

For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots.

You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE>

Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine.

With this approach, full production builds are really fast: ~5 minutes

Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
2024-08-13 16:12:59 -04:00
Guilherme Souza f9751c2e13 chore: official supabase-py (#28209) 2024-07-29 08:00:48 -03:00
Andrew Smith 94d76c5b1e Update supabase python reference docs with params (#23648)
* Update supabase python reference docs with params

* Update the examples in upsert, delete and add rpc

* add missing text_search, or_ and not filters

* Add params and examples for order, limit, range, explain

* add auth signup params and examples

* add sign_in_anonymously to the python docs

* remove all awaits from examples
2024-06-24 14:41:38 -04:00
Mrinank BhowmickandCharis 687c6e3d43 Fix Python code and update docs with responses (#25852)
* Fixed Python code and updated docs with responses (Issue: #22070)

* Made the code readable

* Update apps/docs/spec/supabase_py_v2.yml

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-05-09 17:41:28 +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
Julio Montoya 6ccd9243db Update supabase_py_v2.yml (#22921) 2024-04-19 17:40:37 +00:00
kireev96andCharis d40456632b docs: Update import paths for ClientOptions in documentation (#22344)
Update import paths for ClientOptions in documentation

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-01 16:43:42 +00:00
SHIVAM KRISHNAandCharis b47120cdc1 improve python create user documentation (#22151)
* supabase-js:990 improve python create user documentation

* change link

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-22 02:18:30 +00:00
hawkcookieandCharis 684c478901 docs: Fix broken SITE_URL link (#21896)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-19 08:09:41 +00:00
mpandCharis b683b43b81 Fixed typo on supabase_py_v2.yml (#21199)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-02-14 13:25:20 +00:00
Kevin SeoandCharis Lam 1a423ae7c4 Doc: added missing quotation marks to a dictionary key (#20919)
* doc: route.js changed to route.ts

* doc: added missing quotation marks to a dictionary key

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-02-08 20:51:59 +00:00
Kamil Bażanow 616a6981ba docs(Auth): update signup behavior for existing confirmed user (#20638) 2024-01-22 17:47:53 +00:00
Joel Leeandjoel@joellee.org a423ff201d docs: add MFA methods (#20098)
* fix: add mfa methods

* feat: add mfa docs

* Update spec/supabase_py_v2.yml

* fix: remove comments

* fix: remove reference to nextjs

* feat: change to camel case

---------

Co-authored-by: joel@joellee.org <joel@joellee.org>
2024-01-04 06:36:12 +00:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00