Skip to content
Speccy

Remove one outgoing link that Speccy holds for the doc.

DELETE
/docs/{docId}/links
curl --request DELETE \
  --url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links?base_version=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&kind=implements&target=example'

An adopted link leaves the store, and the repo takes no commit. A link in the frontmatter of a doc Speccy writes leaves the frontmatter as a new version. A link that a repo doc names, or that a link rule makes, stays: the repo or .speccy.yaml holds it.

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.

kind
required
string
Allowed values: implements refines references supersedes implemented-by
target
required
string

The target as written, the target_ref of the link.

Responses

Section titled “ Responses ”

200

Section titled “200”

The link is gone. version is absent when no version was created.

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

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