Make parameter names in core APIs more consistent #52
Conversation
This file contains 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
Firehed
added a commit
that referenced
this pull request
Oct 16, 2024
This reflects the parameter unification in #52
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.
This replaces the
nameparameter during both registration (required) and authentication (optional) withusername. This better reflects what the parameter actually represents, and helps disambiguate it from a display name.In doing so, I've adjusted the calls to the backend during registration to omit this data completely, since only the
upgradeparameter is used in practice. This keeps data filtering simpler.Prior to a 1.0 tag, this retains support for the older
nameparameter at runtime only. TypeScript users will get an immediate type error but nothing will break if they ignore it; plain JS users will get no such warning and things will continue to work. I'll open follow-up tasks to remove it completely.Fixes #48