Files
supabase/apps/docs
e51f24448d docs: Update documentation from SDK changes (Jan 2026) (#42085)
* docs: update documentation from SDK changes (Jan 2026)

This PR updates documentation based on recent changes across all Supabase SDKs.

## Changes Summary

### Auth - X Provider Support
- Added Swift code examples for X (Twitter) OAuth 2.0 authentication
- Updated auth-twitter.mdx with Swift sign-in and sign-out examples
- Complements existing JS, Dart, and Kotlin support

### Storage - Download Query Parameters
- Documented new query parameter support in download() method
- Added examples for Swift (queryItems) and Dart (queryParams)
- Shows how to customize download behavior programmatically

### Storage - Error Handling
- Added section on accessing error details in SDKs
- Documented new status/statusCode properties on JS StorageError
- Documented improved error handling in Python SDK

## SDK Commits Analyzed

- **JavaScript** (v2.91.1-canary.1): 5ed0ce91...HEAD
  - Storage: Exposed status/statusCode on StorageError
  - Auth: Improved signOut with session cleanup
  - Realtime: Added generic overload for postgres_changes

- **Python** (v2.27.2): 1df3afcd...HEAD
  - Storage: Better handling of bad server responses
  - Realtime: Fixed reconnect logic and protocol issues

- **Swift** (v2.40.0): a15b8880...HEAD
  - Storage: Added queryItems support to download method
  - Auth: Added X (OAuth 2.0) provider
  - Functions: Sync auth headers on state change

- **Dart** (yet_another_json_isolate-v2.1.0): af882128...HEAD
  - Storage: Added queryParams support to download method
  - Auth: Added X (OAuth 2.0) provider, fixed getClaims()
  - Storage: Dedicated host for >50GB uploads

- **Kotlin** (3.3.0): 81c7ebab...HEAD
  - Auth: Added X provider support
  - Functions: Fixed error parsing

- **C#** (v1.1.2): e04cc988...HEAD
  - No recent changes requiring documentation updates

## Files Modified

- apps/docs/content/guides/auth/social-login/auth-twitter.mdx
- apps/docs/content/guides/storage/serving/downloads.mdx
- apps/docs/content/guides/storage/debugging/error-codes.mdx

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

* Prettier

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-01-26 08:16:51 -03:00
..
2025-12-01 12:19:35 +00:00
2025-11-28 08:58:11 +00:00
2024-10-24 12:56:20 -02:30
2024-10-24 12:56:20 -02:30

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.