Skip to content

docs: update comments for ScopesSupported #1612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mathetake merged 1 commit into from
Dec 4, 2025
Merged

docs: update comments for ScopesSupported #1612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion api/v1alpha1/mcp_route.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,13 @@ type ProtectedResourceMetadata struct {
// +optional
ResourceName *string `json:"resourceName,omitempty"`

// ScopesSupported is a list of OAuth 2.0 scopes that the resource server supports.
// ScopesSupported defines the minimal set of scopes required for the basic functionality of the MCPRoute.
// It should avoid broad or overly permissive scopes to prevent clients from requesting tokens with excessive privileges.
//
// If an operation requires additional scopes that are not present in the access token, the client will receive a
// 403 Forbidden response that includes the required scopes in the `scope` field of the `WWW-Authenticate` header.
// This enables incremental privilege elevation through targeted `WWW-Authenticate: scope="..."` challenges when
// privileged operations are first attempted.
//
// +kubebuilder:validation:Optional
// +kubebuilder:validation:MaxItems=32
Expand Down
10 changes: 8 additions & 2 deletions manifests/charts/ai-gateway-crds-helm/templates/aigateway.envoyproxy.io_mcproutes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4112,8 +4112,14 @@ spec:
minItems: 1
type: array
scopesSupported:
description: ScopesSupported is a list of OAuth 2.0 scopes
that the resource server supports.
description: |-
ScopesSupported defines the minimal set of scopes required for the basic functionality of the MCPRoute.
It should avoid broad or overly permissive scopes to prevent clients from requesting tokens with excessive privileges.

If an operation requires additional scopes that are not present in the access token, the client will receive a
403 Forbidden response that includes the required scopes in the `scope` field of the `WWW-Authenticate` header.
This enables incremental privilege elevation through targeted `WWW-Authenticate: scope="..."` challenges when
privileged operations are first attempted.
items:
type: string
maxItems: 32
Expand Down
2 changes: 1 addition & 1 deletion site/docs/api/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1811,7 +1811,7 @@ References:
name="scopesSupported"
type="string array"
required="false"
description="ScopesSupported is a list of OAuth 2.0 scopes that the resource server supports."
description="ScopesSupported defines the minimal set of scopes required for the basic functionality of the MCPRoute.<br />It should avoid broad or overly permissive scopes to prevent clients from requesting tokens with excessive privileges.<br />If an operation requires additional scopes that are not present in the access token, the client will receive a<br />403 Forbidden response that includes the required scopes in the `scope` field of the `WWW-Authenticate` header.<br />This enables incremental privilege elevation through targeted `WWW-Authenticate: scope=`...`` challenges when<br />privileged operations are first attempted."
/><ApiField
name="resourceSigningAlgValuesSupported"
type="string array"
Expand Down
Loading