Skip to content

docs(unstable-v2): say every auth method needs methodId and name - #2877

Merged
benbrandt merged 1 commit into
mainfrom
docs/v2-auth-method-required-fields
Nov 18, 2026
Merged

benbrandt merged 1 commit into
mainfrom
docs/v2-auth-method-required-fields

Conversation

@benbrandt

Copy link
Copy Markdown
Member

Summary

The v2 schema requires type, methodId and name on every authentication method. That includes the fallback variant for custom and future method types. The authentication page said every method has a methodId and MUST include a type, but never said name is 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 type discriminator, a methodId, and a name. Changed in the stable page and its draft/ copy.

No requirement changes. The page now states what the schema already requires.

Checks

  • Prettier and typos pass on the changed files.
  • All links and anchors in the changed files resolve.

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.
@benbrandt
benbrandt requested a review from a team as a code owner November 18, 2026 13:17
@benbrandt
benbrandt merged commit bf06b20 into main Nov 18, 2026
10 checks passed
@benbrandt
benbrandt deleted the docs/v2-auth-method-required-fields branch November 18, 2026 15:31
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.

1 participant