docs: link platform api endpoints from operation docs - #141
Open
miru-agents wants to merge 4 commits into
Open
Conversation
Add Platform API endpoint links to the operation sections of the main documentation pages, covering every operation the platform API supports: - devices: get, list, create, ping (update was already linked) - releases: list, create (get was already linked) - deployments: create (stage/patch), get, list, archive, deploy, drifts - config types: get, list, create, update - config instances: get, list, create, download content - config schemas: get, list, create - git commits: get, list, create - provisioning tokens: create (now via PlatformApiLink) - principals: self Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MWYmqc8kbBh6dcQTQyKvgX
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MWYmqc8kbBh6dcQTQyKvgX
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MWYmqc8kbBh6dcQTQyKvgX
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MWYmqc8kbBh6dcQTQyKvgX
miru-agents
marked this pull request as ready for review
July 28, 2026 20:49
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every callable operation in the Platform API (
2026-05-06.rainier— 30 operations across 9 tags) is now explicitly referenced and linked from the documentation page that describes the corresponding product operation, using the existingPlatformApiLinkpattern. Previously only two operations were linked (devices/updatefrom Edit a device andreleases/getfrom View a release).devices/get+devices/list; Provision →devices/create+provisioning-tokens/create; Ping →devices/pingreleases/list; Create →releases/createdeployments/create(target_status: staged); View →deployments/get+deployments/list; Patch →deployments/create(parent_id); Archive →deployments/archive; Deploy →deployments/deploy; Review →deployments/driftsget+list);createandupdatelinked from existing sectionsget,list,download-content,create)config-schemas/create,get,listgit-commits/create,get,listprincipals/self(GET /principal)PlatformApiLinkso it tracks the latest API versionDoc operations with no API endpoint (all of groups, device delete/move, release duplicate/delete, config type delete) intentionally remain unlinked, and the
deployment.validatex-webhooks entry is excluded as it is not a callable operation.Validation
pnpm install --frozen-lockfile && ./scripts/lint.shpasses (MDX prose, ESLint, CSpell, OpenAPI checks)docs/returns exactly the 30-slug inventory from the spec; slugs cross-checked against tag/summary slugification indocs/references/platform-api/2026-05-06.yamlconfig-instances/download-content,principals/self,deployments/drifts,git-commits/create)plans/completed/20260728-platform-api-operation-links.md🤖 Generated with Claude Code
https://claude.ai/code/session_01MWYmqc8kbBh6dcQTQyKvgX
Generated by Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.