Outcome
Set the display order of every section in one documentation space.
These examples were captured from the local Worker. Deployment, publication and retrieval are verified separately for each environment; local examples do not establish external provider delivery.
Before you start
-
Inspect the credential identity with topolo whoami and the exact action with topolo actions get before preparing input.
-
Discover an accessible Docs workspace with topolo resources topolo-docs and topolo workspaces list topolo-docs. Pass workspace resource type and identifier separately from action input.
-
The published required permission is docs:write; the active credential and resource binding must authorize the call.
-
Validate and plan the exact request. Execute only after the intended effect has been authorized; --confirm is the transport guard, not a grant of permission.
Discover the target
topolo actions get app_topolo_docs.spaces.sections.reorder --detail --json
topolo resources topolo-docs --json
topolo workspaces list topolo-docs --json
Discover spaceId with app_topolo_docs.spaces.list in the selected workspace.
Read the document/space identity and call app_topolo_docs.spaces.sections.list for that space.
Input fields
| Field | Required | Meaning |
|---|---|---|
spaceId | Yes | Stable documentation space identifier discovered with spaces.list in the selected workspace. It is separate from the Auth workspace resource identifier. |
sectionIds | Yes | Complete ordered list of the space section identifiers, each exactly once. Omitting, repeating or adding a foreign section fails with section_order_incomplete. |
Interpret the response
sections returns the complete resulting order. Compare its ordered identifiers with sectionIds; every existing section must appear exactly once.
Worked examples
The following inputs and responses were captured from the local Docs worker fixture. Auth and Nexus dependencies are simulated. Identifiers, URLs and timestamps are illustrative fixture values. Discover your own identifiers and choose an appropriate test resource; copying a fixture identifier does not make it valid in your environment. For workspace-bound calls, set DOCS_WORKSPACE_ID to the identifier returned by resource discovery. Run validation and planning first; the final call requires the intended effect to be authorized.
Minimal example
Save the input as payload.json:
{
"spaceId": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
"sectionIds": [
"docsec_9c57d921-baf8-455c-89a0-5abb407cb339"
]
}
CLI:
topolo actions validate app_topolo_docs.spaces.sections.reorder --data @payload.json --json
topolo actions plan app_topolo_docs.spaces.sections.reorder --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.spaces.sections.reorder --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json
MCP tool and arguments:
{
"tool": "topolo_call_action",
"arguments": {
"actionId": "app_topolo_docs.spaces.sections.reorder",
"input": {
"spaceId": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
"sectionIds": [
"docsec_9c57d921-baf8-455c-89a0-5abb407cb339"
]
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"sections": [
{
"id": "docsec_9c57d921-baf8-455c-89a0-5abb407cb339",
"organizationId": "org_fixture",
"workspaceId": "ws_fixture",
"spaceId": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
"slug": "integration-guides",
"title": "Integration guides",
"position": 0,
"createdAt": "2026-10-03T08:07:30.422Z",
"updatedAt": "2026-10-03T08:07:30.491Z"
}
]
}
sections returns the complete resulting order. Compare its ordered identifiers with sectionIds; every existing section must appear exactly once.
Workflow example
Save the input as payload.json:
{
"spaceId": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
"sectionIds": [
"docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4"
]
}
CLI:
topolo actions validate app_topolo_docs.spaces.sections.reorder --data @payload.json --json
topolo actions plan app_topolo_docs.spaces.sections.reorder --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_docs.spaces.sections.reorder --resource-type workspace --resource-id "$DOCS_WORKSPACE_ID" --data @payload.json --confirm --json
MCP tool and arguments:
{
"tool": "topolo_call_action",
"arguments": {
"actionId": "app_topolo_docs.spaces.sections.reorder",
"input": {
"spaceId": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
"sectionIds": [
"docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4"
]
},
"resourceType": "workspace",
"resourceId": "<identifier returned by resource discovery>",
"confirm": true
}
}
Captured local response · HTTP 200:
{
"sections": [
{
"id": "docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4",
"organizationId": "org_fixture",
"workspaceId": "ws_fixture",
"spaceId": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
"slug": "integration-guides",
"title": "Integration guides",
"position": 0,
"createdAt": "2026-10-03T08:07:33.874Z",
"updatedAt": "2026-10-03T08:07:33.938Z"
}
]
}
sections returns the complete resulting order. Compare its ordered identifiers with sectionIds; every existing section must appear exactly once.
Verify the result
- Call spaces.sections.list for the same spaceId and confirm the returned section order matches sectionIds.
Errors and recovery
-
HTTP 422 ·
section_order_incomplete: List the space sections and submit every section id exactly once. -
HTTP 403 ·
forbidden: Use a credential with docs:write access to the selected Docs workspace.
Captured local refusal · HTTP 422
{
"input": {
"spaceId": "docspace_a09c96df-e507-4751-89c8-e6a99e496d0d",
"sectionIds": [
"docsec_9c57d921-baf8-455c-89a0-5abb407cb339",
"docsec_9c57d921-baf8-455c-89a0-5abb407cb339"
]
},
"response": {
"error": "section_order_incomplete"
}
}
Captured local refusal · HTTP 422
{
"input": {
"spaceId": "docspace_a0013653-dabf-4831-8c11-6405b39664ca",
"sectionIds": [
"docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4",
"docsec_37f4c4e1-d416-47d7-ad57-d0a38fb678c4"
]
},
"response": {
"error": "section_order_incomplete"
}
}
Save the complete previous section order before changing it. To restore it, list current sections, reconcile any added or removed identifiers, and plan a complete reorder using the reviewed previous order.
Evidence boundary
These examples establish local handler behavior and schema validity. They do not establish runtime permission parity, a deployed development/staging result or production completion. Preserve the actual request identifier and perform the verification reads after an authorized live call.