Skip to content
Speccy

Compare two versions of a bundle, by file and by section of the main doc (REQ-006).

GET
/docs/{docId}/diff
curl --request GET \
  --url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/diff?from=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&to=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

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”
from
required
string format: uuid
to
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

The differences.

Media typeapplication/json
object
from
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
to
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
files
required
Array<object>
object
path
required
string
status
required
string
Allowed values: added removed modified unchanged
binary
required
boolean
lines
required

Line operations for a modified text file. Empty otherwise.

Array<object>
object
op
required
string
Allowed values: equal insert delete
text
required

One or more whole lines, each ending with a newline except possibly the last line of the file.

string
sections
required

The sections of the main doc, matched by heading path.

Array<object>
object
heading_path
required
Array<string>
status
required
string
Allowed values: added removed modified unchanged
lines
required
Array<object>
object
op
required
string
Allowed values: equal insert delete
text
required

One or more whole lines, each ending with a newline except possibly the last line of the file.

string
Example
{
  "files": [
    {
      "status": "added",
      "lines": [
        {
          "op": "equal"
        }
      ]
    }
  ],
  "sections": [
    {
      "status": "added",
      "lines": [
        {
          "op": "equal"
        }
      ]
    }
  ]
}

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