Skip to content

Update loopback docs#131

Open
Kzoeps wants to merge 1 commit intohypercerts-org:developfrom
Kzoeps:local-dev-docs
Open

Update loopback docs#131
Kzoeps wants to merge 1 commit intohypercerts-org:developfrom
Kzoeps:local-dev-docs

Conversation

@Kzoeps
Copy link
Contributor

@Kzoeps Kzoeps commented Feb 10, 2026

Add info about client_id configuration when using a loopback url

Summary by CodeRabbit

  • Documentation
    • Updated local development OAuth configuration examples with revised baseUrl and redirectUri patterns.
    • Added guidance on scope embedding, loopback OAuth behavior, and production deployment considerations.

@changeset-bot
Copy link

changeset-bot bot commented Feb 10, 2026

⚠️ No Changeset found

Latest commit: 28d1340

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

@coderabbitai
Copy link

coderabbitai bot commented Feb 10, 2026

📝 Walkthrough

Walkthrough

Updated the local development example in the SDK core README to demonstrate loopback-based OAuth client configuration, introducing baseUrl and scope constants, embedding metadata in clientId via query parameters, deriving redirectUri from baseUrl, adjusting jwksUri to base origin, removing the developmentMode flag, and replacing the handleResolver with a production-like HTTPS resolver. Included documentation notes on configuration best practices.

Changes

Cohort / File(s) Summary
SDK Core Documentation
packages/sdk-core/README.md
Updated local development OAuth configuration example to use loopback-based setup with baseUrl, scope, and redirectUri constants; removed developmentMode flag; adjusted resolver and jwksUri; added configuration notes and production cautions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • PR #88: Adds runtime loopback support and corresponding types/tests while this PR adjusts the README documentation and removes the developmentMode flag to align with the new loopback configuration pattern.

Suggested reviewers

  • aspiers

Poem

🐰 Hops through the docs with delight,
OAuth loopback shines so bright,
baseUrl and scope now in place,
Development runs at perfect pace,
No more flags to weigh us down,
Production-ready, we've earned the crown!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update loopback docs' is directly related to the main change, which updates the README documentation for local development to use loopback-based OAuth client configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@packages/sdk-core/README.md`:
- Around line 130-132: The blockquote in README.md contains an empty line inside
the quoted paragraph causing markdownlint MD028; edit the blockquote so there
are no bare blank lines—either remove the blank line or prefix it with ">" to
keep it part of the blockquote (ensure the quoted lines like "**Embed scope and
redirect in client_id**: For loopback clients, embed scope and redirect in
client_id. Otherwise the oauth complains about missing scope and redirect."
remain contiguous and properly prefixed).

Comment on lines +130 to +132
> **Embed scope and redirect in client_id**: For loopback clients, embed scope and redirect in client_id. Otherwise the
> oauth complains about missing scope and redirect.

Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix markdownlint MD028: blank line inside blockquote.

There’s an empty line without > inside the blockquote, which triggers MD028.

🛠️ Suggested fix
 > **Embed scope and redirect in client_id**: For loopback clients, embed scope and redirect in client_id. Otherwise the
 > oauth complains about missing scope and redirect.
- 
+>
 > **Authorization Server Support**: The AT Protocol OAuth spec makes loopback support **optional**. Most AT Protocol
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> **Embed scope and redirect in client_id**: For loopback clients, embed scope and redirect in client_id. Otherwise the
> oauth complains about missing scope and redirect.
> **Embed scope and redirect in client_id**: For loopback clients, embed scope and redirect in client_id. Otherwise the
> oauth complains about missing scope and redirect.
>
> **Authorization Server Support**: The AT Protocol OAuth spec makes loopback support **optional**. Most AT Protocol
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 132-132: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🤖 Prompt for AI Agents
In `@packages/sdk-core/README.md` around lines 130 - 132, The blockquote in
README.md contains an empty line inside the quoted paragraph causing
markdownlint MD028; edit the blockquote so there are no bare blank lines—either
remove the blank line or prefix it with ">" to keep it part of the blockquote
(ensure the quoted lines like "**Embed scope and redirect in client_id**: For
loopback clients, embed scope and redirect in client_id. Otherwise the oauth
complains about missing scope and redirect." remain contiguous and properly
prefixed).

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