mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
61578be9b3
## Summary Updates documentation based on SDK changes from 2026-02-16 to 2026-04-07 across all Supabase client SDKs. ### SDK changes analyzed | SDK | Repository | Commits | Latest Tag | |-----|-----------|---------|------------| | JS | supabase/supabase-js | 78 | v2.104.0-canary.0 | | Dart | supabase/supabase-flutter | 17 | - | | Python | supabase/supabase-py | 11 | v2.28.3 | | Swift | supabase/supabase-swift | 13 | v2.43.0 | | Kotlin | supabase-community/supabase-kt | ~40 | 3.5.0 | | C# | supabase-community/supabase-csharp | 0 (no changes) | v1.1.2 | ### Documentation updates **Spec files:** - **JS** (`supabase_js_v2.yml`): Added custom OIDC/OAuth provider admin CRUD method refs (`createProvider`, `listProviders`, `getProvider`, `updateProvider`, `deleteProvider`) - **Dart** (`supabase_dart_v2.yml`): Added custom OAuthProvider class example, `accessToken` param for `setSession()`, `useNewHostname` storage option - **Swift** (`supabase_swift_v2.yml`): Added PostgREST automatic retries initialization example, realtime callback registration timing note - **Kotlin** (`supabase_kt_v3.yml`): Added streaming edge functions (SSE) example via `collectAsFlow`, `currentPassword` param for `updateUser`, `urlLengthLimit`/`timeout` PostgREST config options **Guides:** - `api/automatic-retries-in-supabase-js.mdx`: Added built-in PostgREST retry documentation (enabled by default since v2.102.0), restructured guide to show native retries first, `fetch-retry` as advanced option - `auth/passwords.mdx`: Added `currentPassword` verification section with JS and Kotlin examples ## Test plan - [ ] Verify YAML spec files parse correctly (validated locally with Python yaml parser) - [ ] Check that `$ref` entries for JS custom provider admin methods resolve correctly against tsdoc - [ ] Review rendered documentation for all updated spec sections - [ ] Verify MDX guide pages render correctly with new Tabs/TabPanel sections 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Documented built-in automatic retries for PostgREST with exponential backoff, retryable status codes, and option to disable per client * Retained prior fetch-retry guidance as a custom alternative * Added guidance for verifying current password (version notes) and admin APIs for custom OAuth providers * Added PostgREST config options, streaming edge-function docs, and clarified realtime subscription callback ordering * Allowed “retryable” in spelling rules <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.