mirror of
https://github.com/supabase/supabase.git
synced 2026-05-08 01:40:13 -04:00
Guilherme Souza
0882677354
## 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>
1514 lines
43 KiB
JSON
1514 lines
43 KiB
JSON
[
|
|
{
|
|
"title": "Introduction",
|
|
"id": "introduction",
|
|
"slug": "introduction",
|
|
"type": "markdown"
|
|
},
|
|
{
|
|
"title": "Installing",
|
|
"id": "installing",
|
|
"slug": "installing",
|
|
"type": "markdown",
|
|
"excludes": ["reference_javascript_v1", "reference_kotlin_v1", "reference_swift_v1"]
|
|
},
|
|
{
|
|
"title": "Initializing",
|
|
"id": "initializing",
|
|
"slug": "initializing",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"title": "TypeScript support",
|
|
"id": "typescript-support",
|
|
"slug": "typescript-support",
|
|
"type": "markdown",
|
|
"excludes": [
|
|
"reference_javascript_v1",
|
|
"reference_dart_v1",
|
|
"reference_dart_v2",
|
|
"reference_python_v2",
|
|
"reference_csharp_v0",
|
|
"reference_csharp_v1",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_kotlin_v3"
|
|
]
|
|
},
|
|
{
|
|
"title": "Upgrade guide",
|
|
"id": "upgrade-guide",
|
|
"slug": "upgrade-guide",
|
|
"type": "markdown",
|
|
"excludes": [
|
|
"reference_javascript_v2",
|
|
"reference_dart_v1",
|
|
"reference_python_v2",
|
|
"reference_csharp_v0",
|
|
"reference_csharp_v1",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_kotlin_v3"
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Database",
|
|
"items": [
|
|
{
|
|
"id": "select",
|
|
"title": "Fetch data",
|
|
"slug": "select",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "insert",
|
|
"title": "Insert data",
|
|
"slug": "insert",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update",
|
|
"title": "Update data",
|
|
"slug": "update",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "upsert",
|
|
"title": "Upsert data",
|
|
"slug": "upsert",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete",
|
|
"title": "Delete data",
|
|
"slug": "delete",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "rpc",
|
|
"title": "Call a Postgres function",
|
|
"slug": "rpc",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "using-filters",
|
|
"isFunc": false,
|
|
"title": "Using filters",
|
|
"slug": "using-filters",
|
|
"product": "database",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "eq",
|
|
"title": "Column is equal to a value",
|
|
"slug": "eq",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "neq",
|
|
"title": "Column is not equal to a value",
|
|
"slug": "neq",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "gt",
|
|
"title": "Column is greater than a value",
|
|
"slug": "gt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "gte",
|
|
"title": "Column is greater than or equal to a value",
|
|
"slug": "gte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "lt",
|
|
"title": "Column is less than a value",
|
|
"slug": "lt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "lte",
|
|
"title": "Column is less than or equal to a value",
|
|
"slug": "lte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "like",
|
|
"title": "Column matches a pattern",
|
|
"slug": "like",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "ilike",
|
|
"title": "Column matches a case-insensitive pattern",
|
|
"slug": "ilike",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "is",
|
|
"title": "Column is a value",
|
|
"slug": "is",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "in",
|
|
"title": "Column is in an array",
|
|
"slug": "in",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "contains",
|
|
"title": "Column contains every element in a value",
|
|
"slug": "contains",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "contained-by",
|
|
"title": "Contained by value",
|
|
"slug": "containedby",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-gt",
|
|
"title": "Greater than a range",
|
|
"slug": "rangegt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-gte",
|
|
"title": "Greater than or equal to a range",
|
|
"slug": "rangegte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-lt",
|
|
"title": "Less than a range",
|
|
"slug": "rangelt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-lte",
|
|
"title": "Less than or equal to a range",
|
|
"slug": "rangelte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-adjacent",
|
|
"title": "Mutually exclusive to a range",
|
|
"slug": "rangeadjacent",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "overlaps",
|
|
"title": "With a common element",
|
|
"slug": "overlaps",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "text-search",
|
|
"title": "Match a string",
|
|
"slug": "textsearch",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "match",
|
|
"title": "Match an associated value",
|
|
"slug": "match",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "not",
|
|
"title": "Don't match the filter",
|
|
"slug": "not",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "or",
|
|
"title": "Match at least one filter",
|
|
"slug": "or",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "filter",
|
|
"title": "Match the filter",
|
|
"slug": "filter",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "using-modifiers",
|
|
"isFunc": false,
|
|
"title": "Using modifiers",
|
|
"slug": "using-modifiers",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "db-modifiers-select",
|
|
"title": "Return data after inserting",
|
|
"slug": "db-modifiers-select",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "order",
|
|
"title": "Order the results",
|
|
"slug": "order",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "limit",
|
|
"title": "Limit the number of rows returned",
|
|
"slug": "limit",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range",
|
|
"title": "Limit the query to a range",
|
|
"slug": "range",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "abort-signal",
|
|
"title": "Set an abort signal",
|
|
"slug": "db-abortsignal",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "single",
|
|
"title": "Retrieve one row of data",
|
|
"slug": "single",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "maybe-single",
|
|
"title": "Retrieve zero or one row of data",
|
|
"slug": "maybesingle",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "csv",
|
|
"title": "Retrieve as a CSV",
|
|
"slug": "db-csv",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "strip-nulls",
|
|
"title": "Strip null values",
|
|
"slug": "db-strip-nulls",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "returns",
|
|
"title": "Override type of successful response",
|
|
"slug": "db-returns",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "overrideTypes",
|
|
"title": "Partially override or replace type of successful response",
|
|
"slug": "db-overrideTypes",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "explain",
|
|
"title": "Using explain",
|
|
"slug": "explain",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Auth",
|
|
"items": [
|
|
{
|
|
"id": "auth-api",
|
|
"title": "Overview",
|
|
"slug": "auth-api",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-up",
|
|
"title": "Create a new user",
|
|
"slug": "auth-signup",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "on-auth-state-change",
|
|
"title": "Listen to auth events",
|
|
"slug": "auth-onauthstatechange",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in",
|
|
"title": "Sign in a user",
|
|
"slug": "auth-signin",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-provider",
|
|
"title": "Sign in a user through OAuth",
|
|
"slug": "auth-signinwithprovider",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-anonymously",
|
|
"title": "Create an anonymous user",
|
|
"slug": "auth-signinanonymously",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-password",
|
|
"title": "Sign in a user",
|
|
"slug": "auth-signinwithpassword",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-id-token",
|
|
"title": "Sign in with ID token (native sign-in)",
|
|
"slug": "auth-signinwithidtoken",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-otp",
|
|
"title": "Sign in a user through OTP",
|
|
"slug": "auth-signinwithotp",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-whatsapp-otp",
|
|
"title": "Sign in a user through WhatsApp",
|
|
"slug": "auth-signinwithwhatsappotp",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-apple",
|
|
"title": "Sign in with Apple",
|
|
"slug": "sign-in-with-apple",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-oauth",
|
|
"title": "Sign in a user through OAuth",
|
|
"slug": "auth-signinwithoauth",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-sso",
|
|
"title": "Sign in a user through SSO",
|
|
"slug": "auth-signinwithsso",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-web3",
|
|
"title": "Sign in a user through Web3 (Solana, Ethereum)",
|
|
"slug": "auth-signinwithweb3",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-passkey",
|
|
"title": "Sign in with a passkey",
|
|
"slug": "auth-signinwithpasskey",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "register-passkey",
|
|
"title": "Register a passkey",
|
|
"slug": "auth-registerpasskey",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-claims",
|
|
"title": "Get user claims from verified JWT",
|
|
"slug": "auth-getclaims",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-out",
|
|
"title": "Sign out a user",
|
|
"slug": "auth-signout",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "reset-password-for-email",
|
|
"title": "Send a password reset request",
|
|
"slug": "auth-resetpasswordforemail",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-update",
|
|
"title": "Update a user",
|
|
"slug": "auth-update",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "set-auth",
|
|
"title": "Update the access token",
|
|
"slug": "auth-setauth",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "user",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-user",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "session",
|
|
"title": "Retrieve a session",
|
|
"slug": "auth-session",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "verify-otp",
|
|
"title": "Verify and log in through OTP",
|
|
"slug": "auth-verifyotp",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "current-session",
|
|
"title": "Retrieve a session",
|
|
"slug": "auth-currentsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "current-user",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-currentuser",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-session",
|
|
"title": "Retrieve a session",
|
|
"slug": "auth-getsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "refresh-session",
|
|
"title": "Retrieve a new session",
|
|
"slug": "auth-refreshsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-user",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-getuser",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-user",
|
|
"title": "Update a user",
|
|
"slug": "auth-updateuser",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-user-identities",
|
|
"title": "Retrieve identities linked to a user",
|
|
"slug": "auth-getuseridentities",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "link-identity",
|
|
"title": "Link an identity to a user",
|
|
"slug": "auth-linkidentity",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "unlink-identity",
|
|
"title": "Unlink an identity from a user",
|
|
"slug": "auth-unlinkidentity",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "send-password-reauthentication",
|
|
"title": "Send a password reauthentication nonce",
|
|
"slug": "auth-reauthentication",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "resend-email-or-phone-otps",
|
|
"title": "Resend an OTP",
|
|
"slug": "auth-resend",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "set-session",
|
|
"title": "Set the session data",
|
|
"slug": "auth-setsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "exchange-code-for-session",
|
|
"title": "Exchange an auth code for a session",
|
|
"slug": "auth-exchangecodeforsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "start-auto-refresh",
|
|
"title": "Start auto-refresh session (non-browser)",
|
|
"slug": "auth-startautorefresh",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "stop-auto-refresh",
|
|
"title": "Stop auto-refresh session (non-browser)",
|
|
"slug": "auth-stopautorefresh",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueclient-initialize",
|
|
"title": "Initialize client session",
|
|
"slug": "auth-initialize",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-mfa-api",
|
|
"title": "Auth MFA",
|
|
"slug": "auth-mfa-api",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "mfa-enroll",
|
|
"title": "Enroll a factor",
|
|
"slug": "auth-mfa-enroll",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-challenge",
|
|
"title": "Create a challenge",
|
|
"slug": "auth-mfa-challenge",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-verify",
|
|
"title": "Verify a challenge",
|
|
"slug": "auth-mfa-verify",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-challenge-and-verify",
|
|
"title": "Create and verify a challenge",
|
|
"slug": "auth-mfa-challengeandverify",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-unenroll",
|
|
"title": "Unenroll a factor",
|
|
"slug": "auth-mfa-unenroll",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-get-authenticator-assurance-level",
|
|
"title": "Get Authenticator Assurance Level",
|
|
"slug": "auth-mfa-getauthenticatorassurancelevel",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotruemfaapi-listfactors",
|
|
"title": "List all factors for current user",
|
|
"slug": "auth-mfa-listfactors",
|
|
"product": "auth",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "passkey-api",
|
|
"isFunc": false,
|
|
"title": "Auth Passkey",
|
|
"slug": "auth-passkey-api",
|
|
"product": "auth",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "passkey-list",
|
|
"title": "List passkeys",
|
|
"slug": "auth-passkey-list",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-update",
|
|
"title": "Update a passkey",
|
|
"slug": "auth-passkey-update",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-delete",
|
|
"title": "Delete a passkey",
|
|
"slug": "auth-passkey-delete",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-start-registration",
|
|
"title": "Start passkey registration",
|
|
"slug": "auth-passkey-startregistration",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-verify-registration",
|
|
"title": "Verify passkey registration",
|
|
"slug": "auth-passkey-verifyregistration",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-start-authentication",
|
|
"title": "Start passkey authentication",
|
|
"slug": "auth-passkey-startauthentication",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "passkey-verify-authentication",
|
|
"title": "Verify passkey authentication",
|
|
"slug": "auth-passkey-verifyauthentication",
|
|
"product": "auth",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "oauth-server-api",
|
|
"isFunc": false,
|
|
"title": "OAuth Server",
|
|
"slug": "auth-admin-oauth-server",
|
|
"product": "auth-admin",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "auth-js-authoauthserverapi-getauthorizationdetails",
|
|
"title": "Get authorization details",
|
|
"slug": "auth-admin-oauth-getauthorizationdetails",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-authoauthserverapi-approveauthorization",
|
|
"title": "Approve authorization",
|
|
"slug": "auth-admin-oauth-approveauthorization",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-authoauthserverapi-denyauthorization",
|
|
"title": "Deny authorization",
|
|
"slug": "auth-admin-oauth-denyauthorization",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-authoauthserverapi-listgrants",
|
|
"title": "List grants",
|
|
"slug": "auth-admin-oauth-listgrants",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-authoauthserverapi-revokegrant",
|
|
"title": "Revoke grant",
|
|
"slug": "auth-admin-oauth-revokegrant",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "admin-api",
|
|
"title": "Auth Admin",
|
|
"slug": "admin-api",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "get-user-by-id",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-admin-getuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "list-users",
|
|
"title": "List all users",
|
|
"slug": "auth-admin-listusers",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "create-user",
|
|
"title": "Create a user",
|
|
"slug": "auth-admin-createuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete-user",
|
|
"title": "Delete a user",
|
|
"slug": "auth-admin-deleteuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "invite-user-by-email",
|
|
"title": "Send an email invite link",
|
|
"slug": "auth-admin-inviteuserbyemail",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "generate-link",
|
|
"title": "Generate an email link",
|
|
"slug": "auth-admin-generatelink",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-user-by-id",
|
|
"title": "Update a user",
|
|
"slug": "auth-admin-updateuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminapi-signout",
|
|
"title": "Sign out a user (admin)",
|
|
"slug": "auth-admin-signout",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-delete-factor",
|
|
"title": "Delete a factor for a user",
|
|
"slug": "auth-admin-mfa-deletefactor",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-list-factors-admin",
|
|
"title": "List all factors for a user (admin)",
|
|
"slug": "auth-admin-mfa-listfactors-admin",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-passkey-api",
|
|
"isFunc": false,
|
|
"title": "Passkey Admin",
|
|
"slug": "auth-admin-passkey-api",
|
|
"product": "auth-admin",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "admin-list-passkeys",
|
|
"title": "List passkeys for a user",
|
|
"slug": "auth-admin-passkey-listpasskeys",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-delete-passkey",
|
|
"title": "Delete a passkey",
|
|
"slug": "auth-admin-passkey-deletepasskey",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "oauth-admin-api",
|
|
"isFunc": false,
|
|
"title": "OAuth Admin",
|
|
"slug": "auth-admin-oauth-admin",
|
|
"product": "auth-admin",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-listclients",
|
|
"title": "List OAuth clients",
|
|
"slug": "auth-admin-oauth-listclients",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-getclient",
|
|
"title": "Get OAuth client",
|
|
"slug": "auth-admin-oauth-getclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-createclient",
|
|
"title": "Create OAuth client",
|
|
"slug": "auth-admin-oauth-createclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-updateclient",
|
|
"title": "Update OAuth client",
|
|
"slug": "auth-admin-oauth-updateclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-deleteclient",
|
|
"title": "Delete OAuth client",
|
|
"slug": "auth-admin-oauth-deleteclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-js-gotrueadminoauthapi-regenerateclientsecret",
|
|
"title": "Regenerate client secret",
|
|
"slug": "auth-admin-oauth-regenerateclientsecret",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-list-clients",
|
|
"title": "List OAuth clients",
|
|
"slug": "auth-admin-oauth-listclients",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-create-client",
|
|
"title": "Create OAuth client",
|
|
"slug": "auth-admin-oauth-createclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-get-client",
|
|
"title": "Get OAuth client",
|
|
"slug": "auth-admin-oauth-getclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-update-client",
|
|
"title": "Update OAuth client",
|
|
"slug": "auth-admin-oauth-updateclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-delete-client",
|
|
"title": "Delete OAuth client",
|
|
"slug": "auth-admin-oauth-deleteclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "admin-oauth-regenerate-client-secret",
|
|
"title": "Regenerate client secret",
|
|
"slug": "auth-admin-oauth-regenerateclientsecret",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Edge Functions",
|
|
"items": [
|
|
{
|
|
"id": "invoke",
|
|
"title": "Invokes a Supabase Edge Function.",
|
|
"slug": "functions-invoke",
|
|
"product": "functions",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "cors-headers",
|
|
"title": "CORS headers for Edge Functions",
|
|
"slug": "functions-cors-headers",
|
|
"product": "functions",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "functions-setauth",
|
|
"title": "Update authorization token",
|
|
"slug": "functions-setauth",
|
|
"product": "functions",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Realtime",
|
|
"items": [
|
|
{
|
|
"id": "realtime-api",
|
|
"title": "Overview",
|
|
"slug": "realtime-api",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "stream",
|
|
"title": "Listen to database changes",
|
|
"slug": "stream",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "subscribe",
|
|
"title": "Subscribe to channel",
|
|
"slug": "subscribe",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-subscription",
|
|
"title": "Remove a subscription",
|
|
"slug": "removesubscription",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-all-subscriptions",
|
|
"title": "Remove all subscriptions",
|
|
"slug": "removeallsubscriptions",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-subscriptions",
|
|
"title": "Retrieve subscriptions",
|
|
"slug": "getsubscriptions",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-channel",
|
|
"title": "Unsubscribe from a channel",
|
|
"slug": "removechannel",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-all-channels",
|
|
"title": "Unsubscribe from all channels",
|
|
"slug": "removeallchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-channels",
|
|
"title": "Retrieve all channels",
|
|
"slug": "getchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "broadcast-message",
|
|
"title": "Broadcast a message",
|
|
"slug": "broadcastmessage",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "realtime-setauth",
|
|
"title": "Set authentication token",
|
|
"slug": "realtime-setauth",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Storage",
|
|
"items": [
|
|
{
|
|
"id": "file-buckets",
|
|
"isFunc": false,
|
|
"title": "File Buckets",
|
|
"slug": "file-buckets",
|
|
"product": "storage",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "storageclient-from",
|
|
"title": "Access a storage bucket",
|
|
"slug": "storageclient-from",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "list-buckets",
|
|
"title": "List all buckets",
|
|
"slug": "storage-listbuckets",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-bucket",
|
|
"title": "Retrieve a bucket",
|
|
"slug": "storage-getbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "create-bucket",
|
|
"title": "Create a bucket",
|
|
"slug": "storage-createbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "empty-bucket",
|
|
"title": "Empty a bucket",
|
|
"slug": "storage-emptybucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-bucket",
|
|
"title": "Update a bucket",
|
|
"slug": "storage-updatebucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete-bucket",
|
|
"title": "Delete a bucket",
|
|
"slug": "storage-deletebucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-upload",
|
|
"title": "Upload a file",
|
|
"slug": "storage-from-upload",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-update",
|
|
"title": "Replace an existing file",
|
|
"slug": "storage-from-update",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-move",
|
|
"title": "Move an existing file",
|
|
"slug": "storage-from-move",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-copy",
|
|
"title": "Copy an existing file",
|
|
"slug": "storage-from-copy",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-url",
|
|
"title": "Create a signed URL",
|
|
"slug": "storage-from-createsignedurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-urls",
|
|
"title": "Create signed URLs",
|
|
"slug": "storage-from-createsignedurls",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-upload-url",
|
|
"title": "Create signed upload URL",
|
|
"slug": "storage-from-createsigneduploadurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-upload-to-signed-url",
|
|
"title": "Upload to a signed URL",
|
|
"slug": "storage-from-uploadtosignedurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-get-public-url",
|
|
"title": "Retrieve public URL",
|
|
"slug": "storage-from-getpublicurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-download",
|
|
"title": "Download a file",
|
|
"slug": "storage-from-download",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-remove",
|
|
"title": "Delete files in a bucket",
|
|
"slug": "storage-from-remove",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-list",
|
|
"title": "List all files in a bucket",
|
|
"slug": "storage-from-list",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "storagefile-exists",
|
|
"title": "Check if file exists",
|
|
"slug": "storage-from-exists",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagefile-info",
|
|
"title": "Get file metadata",
|
|
"slug": "storage-from-info",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagefile-list-v2",
|
|
"title": "List files (v2)",
|
|
"slug": "storage-from-listv2",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagefile-to-base64",
|
|
"title": "Convert file to base64",
|
|
"slug": "storage-from-tobase64",
|
|
"type": "function",
|
|
"product": "storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "analytics-buckets",
|
|
"isFunc": false,
|
|
"title": "Analytics Buckets",
|
|
"slug": "analytics-buckets",
|
|
"product": "storage",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "storageanalytics-from",
|
|
"title": "Access an analytics bucket",
|
|
"slug": "storageanalytics-from",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storageanalytics-createbucket",
|
|
"title": "Create a new analytics bucket",
|
|
"slug": "storageanalytics-createbucket",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storageanalytics-listbuckets",
|
|
"title": "List analytics buckets",
|
|
"slug": "storageanalytics-listbuckets",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storageanalytics-deletebucket",
|
|
"title": "Delete an analytics bucket",
|
|
"slug": "storageanalytics-deletebucket",
|
|
"type": "function",
|
|
"product": "storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "vector-buckets",
|
|
"isFunc": false,
|
|
"title": "Vector Buckets",
|
|
"slug": "vector-buckets",
|
|
"product": "storage",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "storagevectors-from",
|
|
"title": "Access a vector bucket",
|
|
"slug": "storagevectors-from",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagevectors-create-bucket",
|
|
"title": "Create a vector bucket",
|
|
"slug": "storagevectors-createbucket",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagevectors-delete-bucket",
|
|
"title": "Delete a vector bucket",
|
|
"slug": "storagevectors-deletebucket",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagevectors-get-bucket",
|
|
"title": "Retrieve a vector bucket",
|
|
"slug": "storagevectors-getbucket",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "storagevectors-list-buckets",
|
|
"title": "List all vector buckets",
|
|
"slug": "storagevectors-listbuckets",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorbucket-createindex",
|
|
"title": "Create a vector index",
|
|
"slug": "vectorbucket-createindex",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorbucket-deleteindex",
|
|
"title": "Delete a vector index",
|
|
"slug": "vectorbucket-deleteindex",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorbucket-getindex",
|
|
"title": "Retrieve a vector index",
|
|
"slug": "vectorbucket-getindex",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorbucket-listindexes",
|
|
"title": "List all vector indexes",
|
|
"slug": "vectorbucket-listindexes",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorbucket-index",
|
|
"title": "Access a vector index",
|
|
"slug": "vectorbucket-index",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorindex-deletevectors",
|
|
"title": "Delete vectors from index",
|
|
"slug": "vectorindex-deletevectors",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorindex-getvectors",
|
|
"title": "Retrieve vectors from index",
|
|
"slug": "vectorindex-getvectors",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorindex-listvectors",
|
|
"title": "List vectors in index",
|
|
"slug": "vectorindex-listvectors",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorindex-putvectors",
|
|
"title": "Add vectors to index",
|
|
"slug": "vectorindex-putvectors",
|
|
"type": "function",
|
|
"product": "storage"
|
|
},
|
|
{
|
|
"id": "vectorindex-queryvectors",
|
|
"title": "Search vectors in index",
|
|
"slug": "vectorindex-queryvectors",
|
|
"type": "function",
|
|
"product": "storage"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Misc",
|
|
"excludes": [
|
|
"reference_dart_v1",
|
|
"reference_dart_v2",
|
|
"reference_javascript_v1",
|
|
"reference_javascript_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_python_v2",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v3"
|
|
],
|
|
"items": [
|
|
{
|
|
"title": "Release Notes",
|
|
"id": "release-notes",
|
|
"slug": "release-notes",
|
|
"isFunc": false,
|
|
"type": "markdown"
|
|
}
|
|
]
|
|
}
|
|
]
|