Final naming pass (part 2): full 1.0 consistency sweep#90
Merged
Conversation
Make the public API uniformly conventional ahead of the 1.0 freeze: - SupabaseErrorCategory entries to UPPER_SNAKE (CONFLICT, NOT_FOUND, UNAUTHORIZED, RATE_LIMITED, VALIDATION, INTERNAL, NETWORK, UNKNOWN); TextSearchType entries to UPPER_SNAKE (RAW, PLAIN, PHRASE, WEB_SEARCH). Wire values are derived/constructor-held, so identifiers are free to rename. - Realtime: RealtimeSubscription.channel -> channelName, and the matching channel-name parameter on subscribe/subscribeToPostgresChanges/ subscribeToBroadcast/subscribeToPresence/broadcast -> channelName (the channel(name) builder factory is unchanged). - Sync: Record -> SyncRecord, Cursor -> SyncCursor (avoid colliding with kotlin.collections naming and read clearly at call sites). - Storage: ObjectListV2Result -> ObjectListV2Response. - Auth admin: AuditLogEntry -> AuditLogEvent, userinfoUrl -> userInfoUrl. - Client: SupabaseConfig.logLevel -> httpLogLevel (scope is HTTP logging). Regenerated API dumps, updated the reference docs, CHANGELOG and API_DESIGN.
AndroidPoet
force-pushed
the
audit/final-naming
branch
from
b5f147f to
4ef5256
Compare
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
1 participant
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.
The first naming pass landed the safe, high-confidence renames. This second pass finishes the job — resolving the items that were previously deferred — so the public 1.0 surface is uniformly conventional before the freeze. The repo is still at 0.10.0 on Maven, so these renames break no published consumers.
Renames
Enums → UPPER_SNAKE (wire values are derived or constructor-held, so the identifiers are free)
SupabaseErrorCategory:CONFLICT,NOT_FOUND,UNAUTHORIZED,RATE_LIMITED,VALIDATION,INTERNAL,NETWORK,UNKNOWNTextSearchType:RAW,PLAIN,PHRASE,WEB_SEARCHRealtime
RealtimeSubscription.channel→channelNamesubscribe,subscribeToPostgresChanges(all 3 overloads),subscribeToBroadcast,subscribeToPresence, andbroadcast→channelNamechannel(name)builder factory is intentionally unchangedSync
Record→SyncRecord,Cursor→SyncCursorStorage
ObjectListV2Result→ObjectListV2ResponseAuth admin
AuditLogEntry→AuditLogEventuserinfoUrl→userInfoUrlClient
SupabaseConfig.logLevel→httpLogLevel(the setting only scopes HTTP logging;RealtimeConfig.logLevelis a separate concern, left as-is)Deliberately kept
rangeGt/rangeGte/rangeLt/rangeLte— mirrors the operator names; renaming would obscure the mapping.Verification
apiCheck detekt spotlessCheck jvmTest— green; API dumps regenerated