Docs action guides
Inspect a task guide below, then discover the exact action using your current Topolo credential. A documentation page does not grant permission to execute an action.
Before calling an action
topolo whoami --json
topolo actions --service topolo-docs --limit 100 --json
Read the published input and output schemas, resource discovery instructions, effects, verification and recovery. Resolve identifiers in the active context, validate the exact input, and review the plan before an authorized mutation.
Task guides
| Guide | Action |
|---|---|
| Get widget summary | app_topolo_docs.widget.get |
| Get application bootstrap | app_topolo_docs.workspace.bootstrap |
| Get Docs workspace | app_topolo_docs.workspace.get |
| Archive Docs workspace | app_topolo_docs.workspaces.archive |
| List documentation spaces | app_topolo_docs.spaces.list |
| Create documentation space | app_topolo_docs.spaces.create |
| Get documentation space | app_topolo_docs.spaces.get |
| Update documentation space | app_topolo_docs.spaces.update |
| Archive documentation space | app_topolo_docs.spaces.archive |
| List space documents | app_topolo_docs.spaces.documents.list |
| Create document | app_topolo_docs.spaces.documents.create |
| List space sections | app_topolo_docs.spaces.sections.list |
| Create section | app_topolo_docs.spaces.sections.create |
| Reorder space sections | app_topolo_docs.spaces.sections.reorder |
| Rename section | app_topolo_docs.sections.update |
| Delete section | app_topolo_docs.sections.delete |
| File document into a section | app_topolo_docs.documents.section.set |
| List workspace documents | app_topolo_docs.documents.list |
| Get document | app_topolo_docs.documents.get |
| Update document metadata | app_topolo_docs.documents.update |
| Archive document | app_topolo_docs.documents.archive |
| List document versions | app_topolo_docs.documents.versions.list |
| Create document version | app_topolo_docs.documents.versions.create |
| Publish document version | app_topolo_docs.documents.publish |
| Unpublish document | app_topolo_docs.documents.unpublish |
| Search workspace documents | app_topolo_docs.search.query |
| Search a published documentation space | app_topolo_docs.public_search.query |
| Discover published documentation records | app_topolo_docs.public_machine.index |
| Read one published documentation record | app_topolo_docs.public_machine.document |
| Ask workspace documentation | app_topolo_docs.search.ask |
| Export workspace documentation | app_topolo_docs.workspace.export |
Worked response evidence
The guides disclose the local handler fixtures and simulated dependencies used for their worked requests and responses. Fixture identifiers are illustrative. Discover your own authorized targets before planning a live call. Read each guide’s evidence boundary and follow its verification steps.