[SILO-1018] chore: add assets scope definition + update bot token authorize flow#218
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Linked to Plane Work Item(s) This comment was auto-generated by Plane |
📝 WalkthroughWalkthroughDocumentation updates to OAuth authorization flows and scopes. A scope parameter is appended to the Bot Token flow authorization request, and a new Assets scopes section is introduced to the OAuth scopes reference with asset-related permissions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/dev-tools/build-plane-app/choose-token-flow.md (1)
46-52:⚠️ Potential issue | 🟡 MinorScope values in the authorization URL contain raw spaces — should be URL-encoded.
Space characters are not valid in a URL query string without encoding. Per RFC 3986, they must appear as
%20. Although the same issue exists pre-existing at line 156 (User Token flow), line 51 is the only new change in this PR. Developers copy-pasting this URL verbatim may produce a malformed request.📝 Proposed fix
GET https://api.plane.so/auth/o/authorize-app/ ?client_id=YOUR_CLIENT_ID &response_type=code &redirect_uri=https://your-app.com/callback - &scope=scopeA scopeB scopeC + &scope=scopeA%20scopeB%20scopeCApply the same fix to the pre-existing User Token authorization URL (line 156):
- &scope=scopeA scopeB scopeC + &scope=scopeA%20scopeB%20scopeC🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/dev-tools/build-plane-app/choose-token-flow.md` around lines 46 - 52, The authorization URL examples include raw space-separated scopes which must be URL-encoded; update the sample for the client app flow (the GET https://api.plane.so/auth/o/authorize-app/ example) to replace spaces in the scope query with %20-encoded separators, and apply the identical change to the user token flow example (the GET https://api.plane.so/auth/o/authorize/ sample mentioned at line 156) so both docs show properly encoded scope values.
🧹 Nitpick comments (1)
docs/dev-tools/build-plane-app/choose-token-flow.md (1)
46-52: Consider linking to the scopes reference from the scope placeholder.
scopeA scopeB scopeCis used as a generic placeholder across all code blocks in this file. Sinceoauth-scopes.mdis being updated in this same PR, adding a note directing developers to that page would save them a lookup.💡 Suggested addition (after the code block, ~line 53)
+> See [OAuth Scopes](/dev-tools/build-plane-app/oauth-scopes) for the full list of available scope values.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/dev-tools/build-plane-app/choose-token-flow.md` around lines 46 - 52, Add a short note after the GET authorization code example that points readers to the scopes reference by name and links to oauth-scopes.md; reference the placeholder used in the code block ("scopeA scopeB scopeC") and instruct to replace it with actual scopes from oauth-scopes.md so developers can find the scope list quickly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/dev-tools/build-plane-app/choose-token-flow.md`:
- Around line 46-52: The authorization URL examples include raw space-separated
scopes which must be URL-encoded; update the sample for the client app flow (the
GET https://api.plane.so/auth/o/authorize-app/ example) to replace spaces in the
scope query with %20-encoded separators, and apply the identical change to the
user token flow example (the GET https://api.plane.so/auth/o/authorize/ sample
mentioned at line 156) so both docs show properly encoded scope values.
---
Nitpick comments:
In `@docs/dev-tools/build-plane-app/choose-token-flow.md`:
- Around line 46-52: Add a short note after the GET authorization code example
that points readers to the scopes reference by name and links to
oauth-scopes.md; reference the placeholder used in the code block ("scopeA
scopeB scopeC") and instruct to replace it with actual scopes from
oauth-scopes.md so developers can find the scope list quickly.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/dev-tools/build-plane-app/choose-token-flow.mddocs/dev-tools/build-plane-app/oauth-scopes.md
2 participants
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit