chore: register SearchOptions and SortBy in the capability matrix - #1670
Merged
Conversation
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.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe storage file-listing capability metadata now supports ChangesFile listing compliance
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Tr00d
approved these changes
Aug 7, 2026
This was referenced Aug 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SearchOptionsis the options typeStorageFileApi.listtakes, andSortByis the type of itssortByfield. Neither was registered anywhere insdk-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_symbolsonstorage.file_buckets.list_files, alongside the paginated ones.Verified
SortByis referenced only bySearchOptions.sortBy, andSearchOptionsonly byStorageFileApi.list, so neither is shared with another capability.Found while reconciling the merged
list_filesentry in #1667.Test plan
validate-compliance:OK — compliance file is valid.check-drift:✅ No capability matrix drift detected.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:
sdk-compliance.yamlBy 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-symbolsonly 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
@internalinstead (Fetch,Constants,ToQueryParamsand similar look like they were never meant to be public). Not attempting that here.Summary by CodeRabbit