mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Lukas Klingsbo
8c511032b6
## What Addresses @jeremenichelli's feedback that the Dart v2 reference required maintaining section metadata separately from the spec. The reference now derives every method's section from the spec YAML itself, with **no per-method metadata**. ## How Each **section-header** entry in `supabase_dart_v2.yml` carries the `category` and optional `subcategory` that every method after it inherits, up to the next header: - Existing subcategory headers gain a `category`/`subcategory`: `auth-mfa-api`, `passkey-api`, `admin-api`, `admin-passkey-api`, `file-buckets`, `using-modifiers`, `using-filters`. - New top-level category headers mark the sections that previously had no header: `auth-api`, `functions-api`, `database-api`, `realtime-api`. `generate-dart-reference.ts` walks the spec in order, tracking the current section from the most recent header, and tags each method's declaration with it. A method may still set `category`/`subcategory` explicitly to override, and the converter errors if a method appears before any header. ## Why this is less work - **Authoring a new method:** place it in the right section. No `category`/`subcategory` fields, no nav file edit. - **Adding a section:** one header entry (with `category`/`subcategory`) plus its overview partial. - `common-client-libs-sections.json` is not touched (it still drives the legacy-pipeline SDKs). ## Verification The generated navigation (`content/reference/dart/v2/sections.json`, `bySlug.json`) is **byte-for-byte identical** to the previous output. `pnpm codegen:references:new` writes 105 method declarations across 5 categories with no orphaned methods and no slug collisions. Supersedes the earlier per-method-`category` approach on this branch. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Improved Dart/Flutter API reference organization by leveraging spec-provided `category` and `subcategory` taxonomy for clearer grouping (Auth, Passkey, Edge Functions, Database, Realtime, Storage, and database modifiers/filters). * Updated reference generation to use structured in-spec section headers, resulting in more consistent published categorization and navigation. * **Bug Fixes** * Enhanced validation and error messaging for entries that can’t be assigned to a section/category, including clearer guidance on how to fix incomplete spec items. <!-- end of auto-generated comment: release notes by coderabbit.ai -->