Skip to content

Conversation

maximilianfalco
Copy link
Contributor

🚥 Resolves ISSUE_ID

🧰 Changes

This PR adds support for PKCE (Proof Key for Code Exchange) in OAuth authorization code flows by introducing a new usePkce property within the oauth-options extension.

  • Added usePkce?: boolean property to the OAUTH_OPTIONS extension interface
  • When enabled, OAuth authorization code flows should use PKCE with auto-generated code verifier and challenge
  • When disabled (default), uses standard OAuth 2.0 authorization code flow with client credentials

Usage:

{
  "x-readme": {
    "oauth-options": {
      "usePkce": true
    }
  }
}

🧬 QA & Testing

  • Added unit tests for root-level and operation-level usePkce configuration
  • Added tests for multiple OAuth options working together
  • All existing extension tests continue to pass

@erunion erunion added the enhancement New feature or request label Oct 6, 2025
Copy link
Member

@erunion erunion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very minor request but otherwise lgtm

@erunion erunion merged commit edfeec7 into readmeio:main Oct 8, 2025
7 checks passed
@erunion
Copy link
Member

erunion commented Oct 8, 2025

@maximilianfalco I'll work on getting this published and set for deployment today but can you handle updating our docs? https://docs.readme.com/docs/openapi-extensions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants