Skip to content
Speccy

Ask the AI for a patch that fixes one finding (REQ-025). The doc does not change.

POST
/runs/{runId}/findings/{findingId}/fix
curl --request POST \
  --url https://example.com/api/v1/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/findings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fix

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid
findingId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

The suggested patch.

Media typeapplication/json

A patch that replaces one exact text in one file (REQ-025).

object
finding_id
required
string format: uuid
file
required
string
old
required
string
new
required
string
explanation
required
string
version_id
required

The version the patch was written for.

string format: uuid
link_choices

For a missing upstream link, the docs the link can name. The patch is empty; the person picks one, and Speccy writes the link (#75).

Array<object>
object
doc_id
required
string format: uuid
title
required
string
path
required

The doc’s path relative to the root of its source.

string
profile
required
string
Examplegenerated
{
  "finding_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "file": "example",
  "old": "example",
  "new": "example",
  "explanation": "example",
  "version_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "link_choices": [
    {
      "doc_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "title": "example",
      "path": "example",
      "profile": "example"
    }
  ]
}

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