Skip to content

Approve a waiver under the profile's policy (REQ-073, §9.1). A final approval writes it to the doc's sidecar (DEC-009).

POST
/waivers/{waiverId}/approve
curl --request POST \
--url https://example.com/api/v1/waivers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approve
waiverId
required
string format: uuid

The waiver.

Media typeapplication/json
object
id
required
string format: uuid
doc_id
required
string format: uuid
check_slug
required
string
level
required
string
section
required
Array<string>
reason
required
string
status
required

Withdrawn is an approved Acknowledgement that a person took out of the sidecar.

string
Allowed values: requested approved rejected invalidated withdrawn
requested_by
required
string
approvals
required
Array<string>
policy
required

The waiver policy (§9.1).

string
needed
required

The approvals the policy needs.

integer
can_approve
required

Whether the caller can approve or reject it now.

boolean
decision_reason

Why the waiver is rejected. Only a rejected waiver has one.

string
section_range

The byte range of the waiver’s section in the current main doc. Absent when the section is gone.

object
start
required
integer
end
required
integer
trace

An Acknowledgement of one upstream trace ID. On approval it goes in the sidecar under trace.

object
id
required
string
status
required
string
Allowed values: out_of_scope covered_by
target
string
conflict

One conflict between a doc and a linked doc, as a coherence.contradiction finding names it. A waiver of that check binds to it, and excuses no other conflict in the section. On a coherence.downstream-request finding, it is the conflict as the downstream doc names it.

object
with
required

The slug of the linked doc.

string
quote
required

The text of this doc that conflicts.

string
with_quote
required

The text of the linked doc that it conflicts with.

string
verification

What a verification waiver excuses. It never goes in the sidecar.

object
trace_id
required
string
repo
required

The code repo, or the folder, as the verification run names it.

string
run_id

The verification run the request came from. Empty for a request that named no run.

string format: uuid
standalone

True for a standalone Acknowledgement. On approval it goes in the sidecar under standalone.

boolean
upstream_change

True for an upstream request, the answer “The linked doc must change”. On approval it goes in the sidecar under upstream_changes.

boolean
send_back

True for a send-back, the answer “The downstream doc must change” to a coherence.downstream-request finding.

boolean
not_needed

True for the answer “Not needed” to one finding. The author gives it, and it needs no approval.

boolean
downstream

For a send-back, or a waiver of a coherence.downstream-request finding: the downstream doc. The approval writes to its sidecar, because Speccy writes nothing into the linked doc’s sidecar.

object
id
required
string format: uuid
bundle_id
required

The bundle that holds the spec doc.

string format: uuid
slug
required
string
title
required
string
profile_key
required
string
withdrawn_by

Who withdrew the Acknowledgement. Only a withdrawn one has it.

string
ended_because

Why an ended waiver ended: an edit changed its section, a full review passed its whole-doc check, or the profile changed what the check asks. An upstream request ends when the linked doc sends it back, or when an edit removes a quote of its conflict.

string
Allowed values: section_changed check_passed check_changed sent_back conflict_closed
whole_doc

True for a waiver of a whole-doc check. An edit does not end it. It ends when a full review passes the check, or when the profile changes what the check asks.

boolean
created_at
required
string format: date-time
Example
{
"status": "requested",
"trace": {
"status": "out_of_scope"
},
"ended_because": "section_changed"
}

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