Skip to content

feat(oauth2): Define custom scope query param - #391

Open
Cobalt0s wants to merge 1 commit into
mainfrom
cobalt0s/custom-scope-query-param
Open

feat(oauth2): Define custom scope query param#391
Cobalt0s wants to merge 1 commit into
mainfrom
cobalt0s/custom-scope-query-param

Conversation

@Cobalt0s

@Cobalt0s Cobalt0s commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR introduces the scopeQueryParam field to the OpenAPI specification, enabling providers to specify a custom query parameter name for passing OAuth scopes during authorization.

OpenAPI schema change

Added the following field to the OAuth2 options schema:

scopeQueryParam:
  type: string
  description: |
    The query parameter name used to pass OAuth scopes in the authorization URL.
    Defaults to "scope" when not specified. Some providers use a different
    parameter name, such as "user_scope" for Slack user scopes.
  example: user_scope
  x-go-type-skip-optional-pointer: true

All other file changes in this PR are automatically generated from this schema update.

Documentation update

Added installation instructions for the rdme linter to the README:

npm install -g rdme

Motivation

This change is required to support Slack's user-scoped OAuth flow, which uses user_scope instead of the standard scope query parameter. The field is optional and config users should default to scope when nothing is specified, ensuring backward compatibility with existing providers.

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Cobalt0s Cobalt0s self-assigned this Aug 12, 2026
@Cobalt0s
Cobalt0s marked this pull request as ready for review August 12, 2026 21:45
@Cobalt0s Cobalt0s changed the title feat(oauth2): Custom scope query param feat(oauth2): Define custom scope query param Aug 12, 2026
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