Planning

get_document

Read grantRead-onlyIdempotent

Read one of a ticket's documents, such as its Scope or Plan, in Markdown with its revision. One nobody has written yet holds its status's template at revision 0. Needs read access.

Inputs

ticketstringRequired

A ticket ID, such as WEB-31.

documentstringRequired

A document's name or slug from get_ticket, such as Plan or build-record.

tools/callJSON-RPC

1{2  "jsonrpc": "2.0",3  "id": 1,4  "method": "tools/call",5  "params": {6    "name": "get_document",7    "arguments": {8      "ticket": "WEB-31",9      "document": "Plan"10    }11  }12}

POST/clanker/v1/tickets:get-document

1curl -X POST https://api.clankership.com/clanker/v1/tickets:get-document \2  -H "Authorization: Bearer $CLANKER_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "ticket": "WEB-31",6    "document": "Plan"7  }'

Nextwrite_document