Repository navigation
docs(unstable-v2): say every auth method needs methodId and name - #2877
Merged
Merged
Conversation
The v2 schema requires `type`, `methodId` and `name` on every authentication method, including the fallback for custom and future types. The authentication page stated only `type` and `methodId`. Name all three fields in the requirement.
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
The v2 schema requires
type,methodIdandnameon every authentication method. That includes the fallback variant for custom and future method types. The authentication page said every method has amethodIdand MUST include atype, but never saidnameis required.An Agent author who reads only the page could advertise a custom method type without a
name.Change
The requirement now names all three fields: every authentication method MUST include a
typediscriminator, amethodId, and aname. Changed in the stable page and itsdraft/copy.No requirement changes. The page now states what the schema already requires.
Checks
typospass on the changed files.