Skip to content

Ask the reviewer model for the rubric checks of a profile whose pass conditions cannot both hold. A fix for a finding of one such check causes a finding of the other, so a review of a doc does not converge. It changes no profile.

POST
/profiles/conflicts
curl --request POST \
--url https://example.com/api/v1/profiles/conflicts \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "checks": [ { "slug": "example", "question": "example", "pass_when": "example", "section": "example" } ] }'
Media typeapplication/json
object
name

The name of the doc type, such as Software Design Document.

string
checks
required
Array<object>
>= 1 items <= 200 items
object
slug
required
string
question
required
string
pass_when
required
string
section
string
Examplegenerated
{
"name": "example",
"checks": [
{
"slug": "example",
"question": "example",
"pass_when": "example",
"section": "example"
}
]
}

The conflicts. An empty list means the model found none.

Media typeapplication/json
object
conflicts
required
Array<object>
object
checks
required

One slug for a check that pulls against itself, or two or more for checks that pull against each other.

Array<string>
reason
required
string
Examplegenerated
{
"conflicts": [
{
"checks": [
"example"
],
"reason": "example"
}
]
}

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