Skip to content
Speccy

List a run's build questions, reader answers, and results (REQ-040 to REQ-046).

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

Parameters

Section titled “ Parameters ”

Path Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200”

The questions in order. Empty for a run without a divergence test.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
number
required
integer
text
required
string
level
required
string
Allowed values: MUST SHOULD
cites
required
Array<object>
object
kind
required
string
Allowed values: section trace
path
Array<string>
id
string
anchor
required

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
result
required
string
Allowed values: agree diverge gap
answers
required

One per reader, in reader order. Readers are named by number only (DEC-013).

Array<object>
object
reader
required
integer
answer
required
string
answered
required

False for NOT SPECIFIED, and for an answer with no quote found in the bundle (REQ-043).

boolean
quotes
required
Array<object>
object
text
required
string
found
required
boolean
groups
required

The judge’s groups of reader numbers with the same meaning.

Array<Array<integer>>
Example
{
  "items": [
    {
      "level": "MUST",
      "cites": [
        {
          "kind": "section"
        }
      ],
      "result": "agree"
    }
  ]
}

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"
}