Skip to content
Speccy

List the sentences of the current main doc that start with "Assumption:" (REQ-033).

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

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 assumptions.

Media typeapplication/json
object
items
required
Array<object>

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
Examplegenerated
{
  "items": [
    {
      "file": "example",
      "heading_path": [
        "example"
      ],
      "quote": "example",
      "prefix": "example",
      "suffix": "example",
      "start": 1,
      "end": 1,
      "detached": true
    }
  ]
}

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