Skip to content

docs: document all OAuthProviderOptions in README#167

Merged
mattzcarey merged 1 commit intocloudflare:mainfrom
mattzcarey:docs/readme-all-options
Mar 4, 2026
Merged

docs: document all OAuthProviderOptions in README#167
mattzcarey merged 1 commit intocloudflare:mainfrom
mattzcarey:docs/readme-all-options

Conversation

@mattzcarey
Copy link
Contributor

Summary

  • Add accessTokenTTL, allowTokenExchangeGrant, and clientIdMetadataDocumentEnabled to the main config example
  • Add new "Protected Resource Metadata (RFC 9728)" section documenting the resourceMetadata option
  • Rewrite CIMD section to reflect the opt-in flag added in fix: make CIMD explicitly opt-in via clientIdMetadataDocumentEnabled #158 (two-step enablement: option + compat flag)

Test plan

  • npm run check passes (typecheck + 279 tests)
  • Review rendered README on GitHub for formatting

Add documentation for undocumented options: accessTokenTTL,
allowTokenExchangeGrant, clientIdMetadataDocumentEnabled, and
resourceMetadata. Rewrite CIMD section to reflect the new opt-in
flag added in cloudflare#158.
@changeset-bot
Copy link

changeset-bot bot commented Mar 4, 2026

⚠️ No Changeset found

Latest commit: 2227ab1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 4, 2026

Open in StackBlitz

npm i https://pkg.pr.new/cloudflare/workers-oauth-provider/@cloudflare/workers-oauth-provider@167

commit: 2227ab1

@mattzcarey mattzcarey merged commit 94b7f8e into cloudflare:main Mar 4, 2026
4 checks passed
@mattzcarey mattzcarey deleted the docs/readme-all-options branch March 4, 2026 11:21
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