Run the reader check on one work item. Two readers each read only the item and say what they would build. It costs model calls, so it runs only on request.
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/breakdown/readers';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"item":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/breakdown/readers \ --header 'Content-Type: application/json' \ --data '{ "item": "example" }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The ID of one spec doc.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Examplegenerated
{ "item": "example"}Responses
Section titled “ Responses ”The breakdown with the item’s reader check.
The epics and work items Speccy proposed from one Build Ready doc. One per doc. It moves forward with the doc’s versions.
object
The doc version the breakdown quotes.
The doc has a newer version than the one the breakdown quotes.
The verdict the breakdown was taken at.
The breakdown was taken from a doc that was not Build Ready.
Pass it as based_on with an edit.
object
object
The tracker’s ID for the person or the agent.
object
The doc version the issue was pushed from.
object
Bundle/item, which get_work_item takes.
The section the item is anchored on, when the doc has no trace IDs.
object
The slug of the linked spec doc the quote comes from. Absent for this doc.
The agreed build answers for the item’s trace IDs and sections.
object
object
The tracker’s ID for the person or the agent.
object
The tracker’s ID for the person or the agent.
What a newer doc version changed in this item.
object
False when the item changed after the readers read it.
object
The doc version the issue was pushed from.
The trace IDs a person said need no work item.
object
object
Each trace ID of the doc, with the items that hold it.
object
The answer that says the trace ID needs no item.
The trace IDs a newer doc version added. Empty when the breakdown is not stale.
The MUST findings. A push is refused while it is above 0.
The answers that close a coverage finding.
Example
{ "epics": [ { "default_assignee": { "kind": "person" }, "issue": { "tracker": "linear" } } ], "items": [ { "assignee": { "kind": "person" }, "effective_assignee": { "kind": "person" }, "issue": { "tracker": "linear" } } ], "covered": [ { "answer": "out_of_scope" } ], "findings": [ { "level": "MUST" } ]}default
Section titled “default”An error.
RFC 9457 problem details with a stable code.
object
A stable machine-readable error code.
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "code": "example"}