Skip to content

chore: register SearchOptions and SortBy in the capability matrix - #1670

Merged
spydon merged 1 commit into
mainfrom
fix/register-search-options
Aug 7, 2026
Merged

chore: register SearchOptions and SortBy in the capability matrix#1670
spydon merged 1 commit into
mainfrom
fix/register-search-options

Conversation

@spydon

@spydon spydon commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

SearchOptions is the options type StorageFileApi.list takes, and SortBy is the type of its sortBy field. Neither was registered anywhere in sdk-compliance.yaml, so 12 public symbols went unaccounted for, while the paginated equivalents sitting right next to them (PaginatedSearchOptions, FileSort) were listed in full.

Both are supporting types rather than entry points, so they go under supporting_symbols on storage.file_buckets.list_files, alongside the paginated ones.

storage.file_buckets.list_files:
  status: implemented
  symbols:
    - StorageFileApi.list
    - StorageFileApi.listPaginated
  supporting_symbols:
    # ...
    - SearchOptions
    - SearchOptions.limit
    - SearchOptions.offset
    - SearchOptions.search
    - SearchOptions.sortBy
    - SearchOptions.toMap
    - SortBy
    - SortBy.column
    - SortBy.order
    - SortBy.toMap

Verified SortBy is referenced only by SearchOptions.sortBy, and SearchOptions only by StorageFileApi.list, so neither is shared with another capability.

Found while reconciling the merged list_files entry in #1667.

Test plan

  • validate-compliance: OK — compliance file is valid.
  • check-drift: ✅ No capability matrix drift detected.
  • Registered symbol count 887 → 899, exactly the 12 added.

Note on the wider gap

This fixes the case that surfaced in review, but it is one instance of a much larger pattern. Against the current public surface:

count
Public symbols extracted 1952
Registered in sdk-compliance.yaml 899
Unregistered 1051

By package: gotrue 463, realtime_client 230, storage_client 121, supabase_flutter 73, postgrest 71, supabase 64, functions_client 16, yet_another_json_isolate 13.

This is not a regression and does not fail CI, because check-api-symbols only fires on symbols a PR adds, diffing base against head. Everything already present is grandfathered in. But it does mean the matrix currently accounts for under half the public API, which weakens the guarantee the check is meant to provide.

Worth deciding separately whether to backfill, and if so whether some of that surface should be @internal instead (Fetch, Constants, ToQueryParams and similar look like they were never meant to be public). Not attempting that here.

Summary by CodeRabbit

  • New Features
    • Added support for search options and symbol-based sorting when listing files in storage buckets.

SearchOptions is the options type StorageFileApi.list takes, and SortBy
is its sortBy field type. Neither was registered anywhere, so both went
unaccounted for while the paginated equivalents next to them were listed
in full. Both are supporting types rather than entry points, so they go
under supporting_symbols alongside PaginatedSearchOptions.

Found while reconciling the merged list_files entry in #1667.
@spydon
spydon requested a review from a team as a code owner August 7, 2026 13:31
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: f3a5d5c9-e5b3-455a-a6c5-b94945c90105

📥 Commits

Reviewing files that changed from the base of the PR and between 8b6a634 and 9b1de61.

📒 Files selected for processing (1)
  • sdk-compliance.yaml

📝 Walkthrough

Walkthrough

The storage file-listing capability metadata now supports SearchOptions and SortBy, including their constructors, fields, and serialization methods.

Changes

File listing compliance

Layer / File(s) Summary
File listing symbol declarations
sdk-compliance.yaml
Adds SearchOptions and SortBy metadata to storage.file_buckets.list_files, including constructors, fields, and serialization methods.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: dshukertjr

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: registering SearchOptions and SortBy in the capability matrix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/register-search-options

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@spydon
spydon merged commit c6b5b35 into main Aug 7, 2026
28 checks passed
@spydon
spydon deleted the fix/register-search-options branch August 7, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants