Skip to content
Speccy

Summarize what changed in meaning between two versions, and the change in findings (REQ-007).

POST
/docs/{docId}/diff/summary
curl --request POST \
  --url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/diff/summary?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 summary.

Media typeapplication/json
object
summary
required

What changed in meaning, in one or two sentences.

string
changes
required
Array<string>
from_verdict
string
Allowed values: build_ready not_build_ready stale
to_verdict
string
Allowed values: build_ready not_build_ready stale
fixed
required

Findings of the older version that the newer version no longer has.

Array<object>
object
check_slug
required
string
level
required
string
Allowed values: MUST SHOULD INFO
message
required
string
added
required
Array<object>
object
check_slug
required
string
level
required
string
Allowed values: MUST SHOULD INFO
message
required
string
Example
{
  "from_verdict": "build_ready",
  "to_verdict": "build_ready",
  "fixed": [
    {
      "level": "MUST"
    }
  ],
  "added": [
    {
      "level": "MUST"
    }
  ]
}

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