Commit Graph
39 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
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
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 SouzaandClaude 8dfa794ab9 docs(swift): update Swift SDK documentation for recent features (#39332)
This PR updates the Swift SDK documentation to reflect new features from recent merged PRs in supabase-swift:

## Documentation Updates

### PR #812: getClaims method
- Added documentation for new `getClaims()` method for JWT verification
- Supports both symmetric (HS256) and asymmetric (RS256) JWTs
- Includes global JWKS caching with 10-minute TTL
- Handles key rotation gracefully
- Examples: current session, custom JWT, expired tokens, custom JWKS

### PR #809: OAuth 2.1 client admin endpoints
- Added documentation for OAuth 2.1 client administration endpoints
- New methods: `listClients()`, `createClient()`, `getClient()`, `deleteClient()`, `regenerateClientSecret()`
- All methods under `admin.oauth` namespace requiring `service_role` key
- Includes pagination support for listing clients

### PR #806: forceFunctionRegion query parameter
- Updated `invoke()` documentation to mention both `x-region` header and `forceFunctionRegion` query parameter
- Both are set when a region is specified for better function routing

### PR #805: broadcast replay configuration
- Added example for configuring broadcast with replay support
- Shows `ReplayOption` with `since` and `limit` parameters
- Demonstrates how to detect replayed messages via `meta` field

### PR #795: maxAffected method
- Already documented in previous commit (7c29f852c0)
- No changes needed

## Files Updated
- apps/docs/spec/supabase_swift_v2.yml

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

Co-authored-by: Claude <noreply@anthropic.com>
2025-10-08 07:57:03 -03:00
Guilherme Souza 026eb8fb52 docs(swift): add documentation for new Swift SDK features (#39133) 2025-10-01 05:08:39 -03:00
Katerina SkroumpelouandCharis Lam 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
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
Guilherme SouzaandClaude 687667c095 docs: add missing Swift client functions to specification (#37928)
* docs: add missing Swift client functions to specification

Add comprehensive documentation for 26 previously undocumented Swift functions:

- feat: add 17 database filter functions (eq, neq, gt, gte, lt, lte, like, ilike, is, in, contains, containedBy, overlaps, range functions, textSearch)
- feat: add 5 Admin API functions (getUserById, listUsers, createUser, updateUserById, inviteUserByEmail)
- feat: add 2 session management functions (startAutoRefresh, stopAutoRefresh)
- feat: add 2 storage signed URL functions (createSignedUploadUrl, uploadToSignedUrl)

These functions exist in the Swift library but were missing from the documentation spec,
causing a perceived gap compared to the JavaScript client. All additions include proper
Swift syntax examples, async/await patterns, and comprehensive usage documentation.

Closes alignment gap between Swift and JavaScript client documentation.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix params

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-08-25 11:00:09 -03:00
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
Chris Chinchilla 20d2289154 docs: Make Swift client initialization variable consistent (#37838)
Make client initialization variable consistent
2025-08-12 08:37:49 +02: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 da7facdfc1 chore(docs): update Swift Realtime filter to use new filter type (#33748) 2025-02-21 19:22:41 -03:00
Guilherme Souza 53688e6d39 chore(docs): add missing import for swift reference (#33520) 2025-02-19 10:36:48 -05:00
Charis 93885b090f chore: examples (#33183) 2025-01-30 13:08:46 -05:00
Guilherme Souza f7da2bc0f9 chore(docs): add example on initializing swift client with logging (#32629) 2025-01-30 07:17:46 -03: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
Charis 900b4bbad6 fix: swift ref docs filter params (#32633)
Parameters given for `filter` function of Swift SDK don't match actual implementation. Documented as enum, implementation uses string.
2025-01-08 15:08:45 -05:00
Adam Bowker 646989bb91 update swift docs to use referencedTable instead of foreignTable. Closes #29966 (#29968) 2024-10-29 15:58:48 +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
Guilherme Souza 3572ca7970 docs: fix swift realtime samples (#29183) 2024-09-23 07:56:52 -03:00
Guilherme Souza a7cae20ede chore(docs): add swift example for user update with nonce (#27925)
chore(docs): add examle for user update with nonce
2024-07-11 17:03:32 -04:00
Guilherme Souza 34a98b839b chore(docs): add example for fetching custom schema in Swift (#27896) 2024-07-10 09:18:05 -03:00
Guilherme Souza c72fa5d373 chore(docs): add params for swift methods (#27008) 2024-06-29 06:11:32 -03:00
Guilherme Souza ec789d6357 chore(docs): add docs for deep link handling in Swift (#27005) 2024-06-04 15:33:17 -03:00
Guilherme Souza cdd04e5fe5 chore(docs): add linkIdentity and drop .database from swift docs (#26439)
* chore(docs): drop .database from swift examples

* chore(docs): add linkIdentity method to swift docs
2024-05-20 10:51:39 -03:00
Guilherme Souza c287fd309f chore(docs): update reference docs for Swift (#25994) 2024-05-10 14:33:23 -03: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
Guilherme Souza 5128572f16 chore(docs): update swift docs with latest methods (#23149) 2024-04-22 10:09:34 -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 15f9b98966 docs: add signInAnonymously to Swift docs (#22478)
docs: add signInAnonymously to Swift docs
2024-04-04 10:42:06 -04:00
Guilherme Souza 0c215f3f57 docs: add new methods to Swift docs (#22269) 2024-03-26 16:13:06 -04: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
d6f782ee72 docs: 📝 Upload/Replace file documentation #19992 (#19995)
Co-authored-by: ahmad_chand <ahmad.chand_ext@volocopter.com>
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-03-18 05:53:15 +00:00
Kang MingandCharis Lam 30d60342df docs: update phone auth (#21022)
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-02-06 18:45:08 +00:00
ga1azandCharis 643f8110d7 [docs] fix code and response querying foreign table with inner join (#20975)
fix: code and response querying foreign table with inner join

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-02-06 01:42:20 +00:00
Imad Atyat-AllahandCharis 7b92ef9f2e fix: typo from "resetPassswordForEmail" to "resetPasswordForEmail" (#20713)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-01-25 15:56:00 +00:00
Kamil Bażanow 616a6981ba docs(Auth): update signup behavior for existing confirmed user (#20638) 2024-01-22 17:47:53 +00:00
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136) 2024-01-03 18:54:23 +01:00