0882677354
docs: Update SDK reference docs (js 2.105.0, swift 2.45.0, kt 3.6.0, py 2.29.0, dart) ( #45294 )
...
## Summary
Updates SDK reference docs based on recent SDK releases, analyzed
2026-04-16 → 2026-04-27.
## Changes by SDK
### supabase-js `2.104.1 → 2.105.0`
- **New:** Passkey/WebAuthn support — `signInWithPasskey()`,
`registerPasskey()`, full `auth.passkey.*` namespace (list, update,
delete, startRegistration, verifyRegistration, startAuthentication,
verifyAuthentication), and `auth.admin.passkey.*` admin methods
- Passkeys are behind an experimental opt-in flag: `createClient(url,
key, { auth: { experimental: { passkey: true } } })`
### supabase-swift `v2.43.1 → v2.45.0`
- **New:** `stripNulls()` on `PostgrestTransformBuilder` — sets `Prefer:
return=stripped-nulls`, omitting null fields from PostgREST responses
(requires PostgREST 11.2.0+)
### supabase-kt `3.5.0 → 3.6.0`
- **New:** `stripNulls()` in `select { }` block — same PostgREST
stripped-nulls behavior as Swift
### supabase-py `v3.0.0a1 → 2.29.0`
- **New param:** `current_password` added to `UserAttributes` in
`update_user()` — used to verify identity when changing password
### supabase-flutter (dart)
- **New option:** `stream()` now supports `channelOptions: const
RealtimeChannelConfig(private: true)` to use a private Realtime channel
— documented in notes
## Files changed
- `apps/docs/spec/supabase_js_v2.yml` — passkey entries
- `apps/docs/spec/supabase_swift_v2.yml` — stripNulls
- `apps/docs/spec/supabase_kt_v3.yml` — stripNulls
- `apps/docs/spec/supabase_py_v2.yml` — current_password param
- `apps/docs/spec/supabase_dart_v2.yml` — stream private channel note
- `apps/docs/spec/common-client-libs-sections.json` — nav entries for
all new JS passkey methods
---
🤖 Generated with [Claude Code](https://claude.com/claude-code )
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Release Notes
* **New Features**
* Added passkey authentication support with sign-in and registration
capabilities across all SDKs.
* Introduced `stripNulls()` modifier to filter null values from query
responses.
* Enhanced user update method with password verification field.
* Documented private Realtime channel configuration option.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-04-28 10:53:17 +02:00
bc863816fb
docs: Update JS and Kotlin SDK reference (stripNulls, OAuth 2.1 admin) ( #44959 )
...
## Summary
Updates reference docs based on recent SDK changes.
## Changes analyzed
| SDK | Repo | Commits | Latest tag |
|-----|------|---------|------------|
| js | supabase/supabase-js | \`16dd265...7a9b2e1\` | v2.103.3 |
| kt | supabase-community/supabase-kt | \`a671b7a...2a6f456\` | 3.5.0 |
| dart | supabase/supabase-flutter | \`e37539e...01551e3\` | — (dep
bumps only) |
| py | supabase/supabase-py | \`761d972...36cfcd0\` | v3.0.0a1 (dep
bumps only) |
| swift | supabase/supabase-swift | \`17261e9...b2bf858\` | v2.43.1 (dep
bumps only) |
| csharp | supabase-community/supabase-csharp | — | no new commits |
## Documentation updates
### `apps/docs/spec/supabase_js_v2.yml`
- Added `strip-nulls` entry pointing to
`@supabase/postgrest-js.PostgrestTransformBuilder.stripNulls` — new
method in v2.103.0 that strips null values from JSON responses via the
`nulls=stripped` PostgREST media type parameter. TypeScript enrichments
already contain the full documentation.
### `apps/docs/spec/supabase_kt_v3.yml`
- Added OAuth 2.1 client admin CRUD API (`admin.oauth.*`) — new in
supabase-kt 3.5.0: `listClients`, `createClient`, `getClient`,
`updateClient`, `deleteClient`, `regenerateClientSecret`
- Marked `IDToken.Config.data` parameter as deprecated (deprecated
upstream in supabase-kt); updated sign-in example to remove deprecated
usage
### `apps/docs/spec/common-client-libs-sections.json`
- Added `strip-nulls` entry to the Database → Using modifiers nav
section
- Added 6 `admin-oauth-*` entries to the Auth Admin → OAuth Admin nav
section for the new Kotlin OAuth 2.1 methods
---
🤖 Generated with [Claude Code](https://claude.com/claude-code )
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added documentation for the `stripNulls` function to remove null
values from database results.
* Expanded OAuth Admin API documentation with 6 new endpoints for OAuth
client management: list, get, create, update, delete, and secret
regeneration.
* Marked deprecated parameter in ID Token sign-in configuration.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-04-17 08:45:22 -03:00
720c00e4e0
docs: update js sdk docs (2.95.3) ( #42557 )
...
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.
**Details:**
- **Version:** `2.95.3`
- **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>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com >
2026-02-10 12:05:20 +00:00
a552194fb9
docs: manually surface OAuth docs ( #41194 )
2025-12-09 14:33:08 +00:00
964e4b9b1f
docs: update js client libraries (2.86.0) ( #40845 )
2025-11-27 18:10:49 +02:00
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
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
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
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
1c2312975b
docs: add auth getClaims method ( #37122 )
2025-07-14 21:13:23 +00:00
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
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
0381676f91
Add Kotlin v3 docs ( #29531 )
...
* Update docs
* add v3 docs
* add note about kotlin targets
* Apply suggestions from code review
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/spec/supabase_kt_v3.yml
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
2024-10-01 23:57:05 +00:00
d9c43db51d
fix: move Auth error codes to top level ( #29254 )
...
* fix: move error codes to top level
* fix: remove stray newlines
* fix: merge all error sections into central location
* fix: add section heading above table
2024-09-16 07:46:40 +03:00
6bdb4f537e
docs(python): add error codes to the reference docs ( #29162 )
...
* docs(python): add error codes to the reference docs
* docs(python): remove javascript related documentation
2024-09-09 16:02:19 +00:00
33924f0e62
fix: remove frontmatter and repeated H1 from wrappers docs ( #28704 )
2024-08-16 17:41:17 +00:00
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
2fda5c8392
docs: Add error codes reference docs for Flutter ( #28567 )
...
* display error codes for Flutter library
* Create error code file for Flutter error codes reference docs
* Update apps/docs/docs/ref/dart/auth-error-codes.mdx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
2024-08-12 17:40:18 +00:00
eb9f0240cb
docs: Remove error codes section from Flutter, Swift, and Python reference docs. ( #28334 )
...
* exclude dart, python, and swift from error codes menu
* Update the error code doc to be client lib agnostic
* run formatter
* Add a filter to filter out section items
* Update apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefList.tsx
* docs: move error codes table in a separate component
* Add auth error codes section for kotlin
2024-08-06 11:41:10 +09:00
5772fbf911
docs: add error codes auth ( #22793 )
2024-06-08 12:31:52 +02:00
fa8167b26c
chore: Update C# docs to reflect new Nuget Package names and Changelog ( #23148 )
...
* Refresh of c# client docs to reflect Supabase@v1.0.0 and new Nuget Package Names
* Clarify maintainers and contributors
* Separate C# v0 and v1 references
* Format
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
2024-04-23 21:07:29 +00:00
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
9e4b7e4991
docs: anonymous sign-ins ( #21801 )
...
* docs: add guide for anonymous sign-ins
* docs: add signInAnonymously to reference docs
* docs: update tsdocs to include signInAnonymously
* docs: update RLS policies page
* fix: make reference generator more resilient
* docs: update nodes to use auth-js naming
* docs: update tsdocs
* docs: update signInAnonymously method
* docs: add abuse prevention & cleanup to anonymous users guide
* docs: update rate limit table
* docs: update automatic cleanup section
* docs: update access control & abuse prevention
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com >
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com >
* docs: update access control
* Update apps/docs/content/guides/auth/auth-anonymous.mdx
Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com >
* docs: update anonymous users guide
* docs: update anonymous user guide
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
Co-authored-by: Joel Lee <lee.yi.jie.joel@gmail.com >
Co-authored-by: Stojan Dimitrovski <sdimitrovski@gmail.com >
2024-03-27 18:01:07 +07:00
a564bd5bd4
docs: add info about React Native AppState and Supabase Auth ( #20287 )
2024-01-22 16:46:41 +00:00
129b3d927a
chore: move specs to docs folder ( #20136 )
2024-01-03 18:54:23 +01:00
Guilherme Souza