Skip to content
Speccy

Answer a coverage gap with "This doc covers it". Speccy adds "Covers <ID>." at the end of the section as a new version.

POST
/docs/{docId}/trace/cover
curl --request POST \
  --url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/trace/cover?base_version=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Content-Type: application/json' \
  --data '{ "trace_id": "example", "section": [ "example" ] }'

Parameters

Section titled “ Parameters ”

Path Parameters

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

The ID of one spec doc.

Query Parameters

Section titled “Query Parameters”
base_version
required
string format: uuid

The version the change is based on. When the bundle has a newer version, the request fails with code version_conflict, so a change never overwrites one it did not see.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
trace_id
required
string
section
required

The heading path of the section that covers the ID.

Array<string>
Examplegenerated
{
  "trace_id": "example",
  "section": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The new version.

Media typeapplication/json
object
version
required
object
id
required
string format: uuid
number
required
integer format: int64
created_by
required
string
message
required
string
created_at
required
string format: date-time
changed
required

False when the write left the bundle unchanged, so no version was created.

boolean
Examplegenerated
{
  "version": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "number": 1,
    "created_by": "example",
    "message": "example",
    "created_at": "2026-04-15T12:00:00Z"
  },
  "changed": 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"
}