Skip to content
Speccy

The ordered points of the bundle's current review that need a human decision (SDD §13.3).

GET
/docs/{docId}/tour
curl --request GET \
  --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tour

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
docId
required
string format: uuid

The ID of one spec doc.

Responses

Section titled “ Responses ”

200

Section titled “200”

The tour.

Media typeapplication/json
object
run_id

The run whose findings the tour uses. Absent before the first review.

string format: uuid
points
required
Array<object>

One point that needs a human decision. The ask states one explicit decision.

object
key
required
string
kind
required
string
Allowed values: blocking_thread finding waiver open_decision
ask
required
string
context
required

Why the point needs a decision, in one or two sentences.

string
level
string
Allowed values: MUST SHOULD INFO
check_slug
string
anchor

A range of text with context (SDD §8.8).

object
file
required
string
heading_path
required
Array<string>
quote
required
string
prefix
required
string
suffix
required
string
start
required

Byte offset of the quote in the file.

integer
end
required
integer
detached

The text changed, and Speccy cannot find the quote in the current version (SDD §8.8).

boolean
finding_id
string format: uuid
thread_id
string format: uuid
waiver_id
string format: uuid
can_approve

For a waiver, the caller can approve or reject it now.

boolean
trace_id

For a coverage gap, the upstream trace ID it is about.

string
Example
{
  "points": [
    {
      "kind": "blocking_thread",
      "level": "MUST"
    }
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}