Add standalone access tokens page for new dashboard UI#3291
Add standalone access tokens page for new dashboard UI#3291
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughDocumentation additions and updates consolidate access token guidance into a dedicated resource. A new navigation entry directs users to comprehensive access token documentation covering creation, capability mapping, revocation, and rate limits. Existing platform documentation updated to reference this new guide. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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)
📝 Coding Plan
Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/pages/docs/platform/account/control-api.mdx (1)
33-47:⚠️ Potential issue | 🟡 MinorUpdate the downstream token reference to prevent a broken in-page link.
After this auth-content move, the page no longer defines
#creating-access-token, but Line 814 still links to it. That reference should point to the new access token page anchor instead.Suggested fix (outside this selected range)
-First, you need to [obtain a Control API token](`#creating-access-token`) to authenticate any requests you send to the Control API. +First, you need to [obtain a Control API token](/docs/platform/account/access-tokens#create) to authenticate any requests you send to the Control API.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/pages/docs/platform/account/control-api.mdx` around lines 33 - 47, The page still contains links pointing to the removed in-page fragment "#creating-access-token"; find occurrences of that fragment (the broken link referenced in the comment) and update them to point to the correct access-token page anchor instead (replace "#creating-access-token" with the new anchor on the access tokens page, e.g. "/docs/platform/account/access-tokens" or "/docs/platform/account/access-tokens#<new-anchor>"). Ensure you update the link target(s) in this file (control-api.mdx) so they reference the external access-tokens page/anchor rather than the removed in-page id.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/pages/docs/platform/account/index.mdx`:
- Line 65: The "Access tokens" section heading lacks the required HTML anchor;
update the heading line for "Access tokens" to include a standard HTML anchor
tag (e.g., add <a id="access-tokens"/> after the heading text) so it follows the
docs convention of "Use standard markdown headings with HTML anchor tags for
section headers" and ensure the anchor id is unique and kebab-case.
---
Outside diff comments:
In `@src/pages/docs/platform/account/control-api.mdx`:
- Around line 33-47: The page still contains links pointing to the removed
in-page fragment "#creating-access-token"; find occurrences of that fragment
(the broken link referenced in the comment) and update them to point to the
correct access-token page anchor instead (replace "#creating-access-token" with
the new anchor on the access tokens page, e.g.
"/docs/platform/account/access-tokens" or
"/docs/platform/account/access-tokens#<new-anchor>"). Ensure you update the link
target(s) in this file (control-api.mdx) so they reference the external
access-tokens page/anchor rather than the removed in-page id.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: d1ab5fca-1f91-435d-b4dd-3da3d0afefa7
📒 Files selected for processing (5)
src/data/nav/platform.tssrc/pages/docs/platform/account/access-tokens.mdxsrc/pages/docs/platform/account/control-api.mdxsrc/pages/docs/platform/account/index.mdxsrc/pages/docs/platform/tools/cli.mdx
| | Write Rule | `write:rule` | [Create](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules/post), [update](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules~1{rule_id}/patch), and [delete](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules~1{rule_id}/delete) integration rules | `ably integrations create`, `ably integrations update`, `ably integrations delete` | | ||
| | Read Queue | `read:queue` | [List](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues/get) queues for an app | `ably queues list` | | ||
| | Write Queue | `write:queue` | [Create](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues/post) and [delete](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues~1{queue_id}/delete) queues | `ably queues create`, `ably queues delete` | | ||
| | Read Namespace | `read:namespace` | [List](/docs/api/control-api#tag/namespaces/paths/~1apps~1{app_id}~1namespaces/get) channel namespaces for an app | `ably apps channel-rules list` | |
There was a problem hiding this comment.
This has changed to apps rules
There was a problem hiding this comment.
Don't think it's released yet(seems 0.17.0 is the latest released). See in the CLI PR it's backwards compatible so okay to keep as channel-rules until new CLI version is released.
| | Write App | `write:app` | [Create](/docs/api/control-api#tag/apps/paths/~1accounts~1{account_id}~1apps/post), [update](/docs/api/control-api#tag/apps/paths/~1apps~1{id}/patch), and [delete](/docs/api/control-api#tag/apps/paths/~1apps~1{id}/delete) apps | `ably apps create`, `ably apps update`, `ably apps delete` | | ||
| | Read Key | `read:key` | [List](/docs/api/control-api#tag/keys/paths/~1apps~1{app_id}~1keys/get) API keys for an app | `ably auth keys list`, `ably auth keys get` | | ||
| | Write Key | `write:key` | [Create](/docs/api/control-api#tag/keys/paths/~1apps~1{app_id}~1keys/post), [update](/docs/api/control-api#tag/keys/paths/~1apps~1{app_id}~1keys~1{key_id}/patch), and [revoke](/docs/api/control-api#tag/keys/paths/~1apps~1{app_id}~1keys~1{key_id}~1revoke/post) API keys | `ably auth keys create`, `ably auth keys update`, `ably auth keys revoke` | | ||
| | Read Rule | `read:rule` | [List](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules/get) and [get](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules~1{rule_id}/get) integration rules | `ably integrations list`, `ably integrations get` | |
There was a problem hiding this comment.
We should just call this Read Integration to align with other docs
There was a problem hiding this comment.
(And possibly consider a V2 of the Control API to get the terminology right)
There was a problem hiding this comment.
Updated. Will create a backlog ticket for V2 consideration
| | Write Rule | `write:rule` | [Create](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules/post), [update](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules~1{rule_id}/patch), and [delete](/docs/api/control-api#tag/rules/paths/~1apps~1{app_id}~1rules~1{rule_id}/delete) integration rules | `ably integrations create`, `ably integrations update`, `ably integrations delete` | | ||
| | Read Queue | `read:queue` | [List](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues/get) queues for an app | `ably queues list` | | ||
| | Write Queue | `write:queue` | [Create](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues/post) and [delete](/docs/api/control-api#tag/queues/paths/~1apps~1{app_id}~1queues~1{queue_id}/delete) queues | `ably queues create`, `ably queues delete` | | ||
| | Read Namespace | `read:namespace` | [List](/docs/api/control-api#tag/namespaces/paths/~1apps~1{app_id}~1namespaces/get) channel namespaces for an app | `ably apps channel-rules list` | |
There was a problem hiding this comment.
Read Rule ?
Though appreciate it may confuse with the integrations section
There was a problem hiding this comment.
Updated, it's matches dashboard terminology so shouldn't cause any confusion
Access tokens are used by both the Control API and CLI, so they now have their own page at /docs/platform/account/access-tokens rather than being documented inline in the Control API page. - Create access-tokens.mdx with creation flow, capability table (with Control API and CLI command mappings), revocation, and rate limits - Slim down control-api.mdx auth section to link to new page - Rename "My Access Tokens" to "Access tokens" throughout - Remove outdated screenshots from Control API page - Add access tokens nav entry in platform.ts - Link CLI docs to new access tokens page
matt423
force-pushed
the
dx-563-access-tokens
branch
from
dde3439 to
ed72fc9
Compare
3 participants
Summary
Note
To be merged when tokens website PR is deployed
/docs/platform/account/access-tokenscovering token creation, capabilities, revocation, and rate limitsTest plan
Review App
/docs/platform/account/access-tokensrenders correctlyreview-applabelSummary by CodeRabbit
New Features
Documentation