Skip to content

docs: document CIMD OAuth support - #985

Merged
chrisdoc merged 1 commit into
mainfrom
docs/cimd-oauth-documentation
Aug 11, 2026
Merged

docs: document CIMD OAuth support#985
chrisdoc merged 1 commit into
mainfrom
docs/cimd-oauth-documentation

Conversation

@charliecreates

@charliecreates charliecreates Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the hosted Worker's Client ID Metadata Document (CIMD) OAuth support and clarify that /register remains the dynamic-registration fallback.

Source evidence

Documentation

  • File changed: README.md (hosted Worker OAuth section).
  • The section was stale because it described only dynamic client registration and omitted the CIMD flow now supported by the merged Worker change.

Verification

  • oxfmt README.md --check
  • git diff --check
  • changeset status --since=origin/main
  • node scripts/check-package-changesets.mjs --since origin/main

— charlied/docs-drift-maintainer

Summary by Sourcery

Documentation:

  • Update README hosted Worker OAuth section to describe CIMD support and position /register dynamic client registration as a fallback, alongside existing PKCE token exchange details.

✨ PR Description

Purpose: Update documentation to clarify CIMD OAuth support and dynamic client registration capabilities for the streaming endpoint.

Main changes:

  • Added Client ID Metadata Documents (CIMD) specification with dynamic client registration fallback and PKCE token exchange details
  • Updated compatibility requirements text to explicitly mention CIMD and token refresh as OAuth layer prerequisites

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Description using Guidelines Learn how

@assert-app

assert-app Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review on Assert →

2 clusters identified

Merge candidate is ready!

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @charliecreates[bot], you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@sourcery-ai

sourcery-ai Bot commented Aug 11, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates the hosted Worker OAuth documentation to reflect current support for Client ID Metadata Documents (CIMD), clarifying that dynamic client registration via /register is now a fallback alongside PKCE token exchange and updating compatibility wording accordingly.

Sequence diagram for hosted Worker OAuth discovery with CIMD and /register fallback

sequenceDiagram
    participant OAuthClient
    participant WorkerOAuth

    OAuthClient->>WorkerOAuth: GET /.well-known/openid-configuration
    OAuthClient->>WorkerOAuth: GET CIMD (Client ID Metadata Document)
    alt CIMD_supported
        OAuthClient->>WorkerOAuth: POST /token (PKCE)
    else CIMD_not_supported
        OAuthClient->>WorkerOAuth: POST /register
        OAuthClient->>WorkerOAuth: POST /token (PKCE)
    end
Loading

File-Level Changes

Change Details Files
Update hosted Worker OAuth docs to describe CIMD support and clarify /register as a fallback registration flow.
  • Expand the bullet list of hosted Worker OAuth capabilities to include CIMD with /register as a fallback and /token PKCE exchange.
  • Adjust the compatibility description to mention CIMD as an additional requirement for clients that depend on OAuth discovery, registration, or token refresh.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@deepsource-io

deepsource-io Bot commented Aug 11, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in 31c5eb3...4d015f9 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
JavaScript Aug 11, 2026 10:05a.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

@github-actions

Copy link
Copy Markdown
Contributor

Cloudflare Worker preview

@gitstream-cm gitstream-cm Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✨ PR Review

LGTM

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Review using Guidelines Learn how

@codecov

codecov Bot commented Aug 11, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@codecov

codecov Bot commented Aug 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.75%. Comparing base (31c5eb3) to head (4d015f9).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #985   +/-   ##
=======================================
  Coverage   73.75%   73.75%           
=======================================
  Files          92       92           
  Lines        6107     6107           
  Branches     1733     1733           
=======================================
  Hits         4504     4504           
  Misses       1023     1023           
  Partials      580      580           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@github-actions

Copy link
Copy Markdown
Contributor

Unit Test Results

  1 files   78 suites   32s ⏱️
775 tests 775 ✅ 0 💤 0 ❌
782 runs  782 ✅ 0 💤 0 ❌

Results for commit 4d015f9.

@chrisdoc
chrisdoc merged commit 0b03a0d into main Aug 11, 2026
38 checks passed
@chrisdoc
chrisdoc deleted the docs/cimd-oauth-documentation branch August 11, 2026 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants