docs: clarify scoped access token entitlement - #1579
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
@brendan-kellam your pull request is missing a changelog! |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
WalkthroughThe change updates scoped access token documentation. Endpoint descriptions remove detailed authentication requirements. OpenAPI metadata and authentication documentation now state that access requires a custom entitlement and provide a contact address. ChangesScoped access token documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Summary
Validation
yarn workspace @sourcebot/web exec eslint src/openapi/publicApiDocument.tsgit diff --checkNo changelog entry because this is a documentation-only change.
Note
Low Risk
Documentation and OpenAPI description changes only; no runtime or auth behavior changes.
Overview
This PR updates scoped access token docs so readers know the feature needs a custom entitlement and how to request it (
team@sourcebot.dev).It adds a shared Mint Info callout via
SCOPED_ACCESS_TOKEN_ENTITLEMENT_INFOon create and revoke inpublicApiDocument.ts(x-mint), mirrors the same callout inauthentication.mdx, and shortens the OpenAPI endpoint descriptions (dropping long auth/repo-validation detail from the spec text). The checked-insourcebot-public.openapi.jsonis regenerated to match.Reviewed by Cursor Bugbot for commit 8928f45. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
team@sourcebot.devfor access.