Skip to content

Propose an endpoint for the API catalog

POST
/v1/review-items/endpoints
curl --request POST \
--url https://beta-api.plune.ai/v1/review-items/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "method": "GET", "path": "/orders/{orderId}", "source": "code", "summary": "One order" }'

An agent (a write token sending X-Plune-Session), or anyone who may write, says it found an endpoint (#2192): the fifth kind of queue entry, pending until a person decides it as any proposal is decided - approving it writes the endpoint into the catalog. The entry already waiting for the same API, method and path shape is answered (200) instead of a second one; approving writes into the API it names. A waiting endpoint takes a place under the queue’s ceiling (429 quota, kind: pendingReviewItems). Read them with GET /v1/review-items?kind=endpoint.

Media type application/json

An endpoint an agent found (#2192). Approving the queue entry writes it into the project’s API catalog.

object
apiId

The API it is for; left out, the project’s only one (or none yet). With several APIs it is named (400 api_required)

string
method
required

Upper or lower case; stored upper case

string
Allowed values: GET PUT POST DELETE OPTIONS HEAD PATCH TRACE
path
required

A path TEMPLATE: it starts with /, a parameter is a whole segment written {name}, and a segment that names one thing - digits, a UUID, a long hex run, anything with @ - is refused: write it as a parameter. No query, no fragment.

string
>= 1 characters <= 512 characters
source
required
string
Allowed values: spec code traffic
trust

derived when left out; approving says the endpoint belongs in the catalog, not that its description is right

string
Allowed values: confirmed derived
summary
string
>= 1 characters <= 500 characters
auth

The auth scheme names it asks for, as a spec names them; [] is public

Array<string>
<= 10 items
environment

Where the agent saw it

string
>= 1 characters <= 100 characters
seenAt

When the agent saw it; a time ahead of the server is taken as the moment of the approval

string format: date-time
Example
{
"method": "GET",
"path": "/orders/{orderId}",
"source": "code",
"summary": "One order"
}

The entry already waiting for this endpoint

Media type application/json

One entry of the review queue. Always starts pending; a reviewer moves it on.

object
schemaVersion
required
integer
Allowed values: 1
id
required
string format: uuid
resultId

Present on an entry disputing a RESULT. Exactly one of resultId, proposedCase, discoveredTest, question, proposedEndpoint, strategy, report, memoryRule and automation is present: an entry with two asks two questions at once, and one with none asks nothing.

string format: uuid
proposedCase

Present on an entry proposing a new case. Mutually exclusive with the other kinds.

object
stableId
required

Content-derived identity; the dedup key.

string
title
required
string
<= 300 characters
execution
required
string
Allowed values: auto manual
steps
required
Array<string>
>= 1 items <= 20 items
expected
required
string
<= 2000 characters
origin
required
One of:
object
runId
required
string
mode
required
string
Allowed values: explore design api mcp
target
required
string
technique
string
<= 32 characters
priority
string
source
object
kind
required
string
Allowed values: url openapi-operation requirement pasted-text jira-ticket
value
required
string
>= 1 characters <= 100 characters
rationale
string
>= 1 characters <= 400 characters
lint

What the pre-review checks found, written before the proposal was queued (#1289). It marks the proposal. Only placeholder stops anything: a proposal whose title, steps or expected result still holds {{...}}, [TODO]/[TBD]/[FIXME]/[XXX] (or the same in <...>) or a run of three or more underscores cannot be approved (409 naming the places), and that check is read off the reviewer’s edited version when there is one. Absent means nothing was found.

Array<object>
object
rule
required
string
Allowed values: title-vague step-empty expected-vague duplicate-case duplicate-proposal placeholder
message
required
string
url
required

Where the rule is explained.

string
runCost
object
tokens
required
integer
cases
required
integer
verdict

Absent means never executed — NOT “no result yet”. blocked: no answer from the target.

string
Allowed values: passed failed blocked
externalKeys

What a match resolves through. Absent is a normal proposal, not a degraded one: an agent that names no key gets an entry with no comparison, which is exactly what a genuinely new case gets.

Array<object>
<= 32 items

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
editedCase

The reviewer’s corrected version of the proposal (#1878), beside proposedCase, which stays what the agent said. Present only after an edit; approving the item makes the case from it. Left off the page of the listing (editedBy and editedAt stay).

object
title
required
string
<= 300 characters
steps
required
Array<string>
>= 1 items <= 20 items
expected
required
string
<= 2000 characters
editedBy

The user id of whoever saved the version in editedCase.

string
editedAt

When editedCase was saved.

string format: date-time
discoveredTest

Present on an entry reporting a test the caller RUNS and this project has no case for. Mutually exclusive with the other kinds.

object
keys
required

The identity. Order does not matter — the server ranks them and the highest-ranked kind is what deduplication reads, so two adapters sending the same keys in a different order do not produce two entries about one test.

Array<object>
>= 1 items <= 8 items

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
title
required
string
<= 300 characters
source
required

The reporter that found it, e.g. playwright.

string
<= 32 characters
specRef
required

Where the test lives, e.g. e2e/checkout.spec.ts:12. Required while everything descriptive is optional: an approved discovery becomes an automated case, and that shape needs a spec to point at.

string
<= 400 characters
rawStatus

What it did on this run, in the reporter’ own word.

string
<= 64 characters
platformRunId

The run that turned it up, once stored.

string
question

Present on an entry asking a person a question (#2189). Mutually exclusive with the other kinds.

object
template
required
string
Allowed values: plain access failure
text
required

Trimmed. On failure, the explanation: at most 500 characters.

string
>= 1 characters <= 2000 characters
missionId

The mission the question is about (#2188), one of this project’s: another project’s, or one nobody made, is a 404 mission not found.

string
options

plain only. Each trimmed; no two the same.

Array<string>
>= 1 items <= 3 items
access

access only, and required there; each kind once. openapi: an API description (OpenAPI or Postman); repo: read-only access to the code; staging: a staging host with a test account; har: a HAR file.

Array<string>
>= 1 items <= 4 items
Allowed values: openapi repo staging har
resultId

failure only, and required there: a result of this project in a live run, failed or broken, of a live case. Another project’s, or one nobody made, is a 404; one that did not fail is a 409 result_not_failed; a second waiting question on one result is a 409 already_asked. GET /v1/review-items?resultId= finds the question for the result’s page.

string
testCaseId

failure only: the case of the result, read off the result by the server - never sent (a body that names it is a 400).

string
category

failure only, and required there: why the test failed. app-bug the application; selector, timing, data, environment, dependency; and Cairn’s covered-by-overlay, ambiguous-locator, dead-click. Copied onto the answer.

string
Allowed values: app-bug selector timing data environment dependency covered-by-overlay ambiguous-locator dead-click
actions

failure only, and required there: one to three actions, each kind once. A page of the queue carries a fix without its code (codeGiven: true).

Array<object>
>= 1 items <= 3 items

An action a failure question offers (#2195), carried out by the answer that picks it (answer.action), as the person who answered. file-bug: a bug from the result, titled title, its case linked and the result its evidence - or, with bugId, the result added as evidence to that bug of the project (one of the two). accept-fix: the case’s code (codeSnapshot) becomes code; automated cases only (else 400 action_not_for_case). expected-change: the product changed on purpose - a manual case’s expected result becomes expected, an automated case’s code becomes code. quarantine: the case is muted, and its results in open runs count as muted. baseHash (sha256 hex of the code the fix was written against): when given and the case’s code has moved since, the answer is a 409 code_changed.

object
kind
required
string
Allowed values: file-bug accept-fix expected-change quarantine
title

file-bug: the title of the bug to file.

string
>= 1 characters <= 200 characters
bugId

file-bug: a live bug of the project the result is added to; another one is a 404.

string
code

accept-fix, expected-change: the whole fixed test() call, at most 16 384 bytes.

string
>= 1 characters
expected

expected-change on a manual case: its new expected result.

string
>= 1 characters <= 2000 characters
baseHash
string
/^[0-9a-f]{64}$/
codeGiven

On a page of the queue, in place of code.

boolean
proposedEndpoint

Present on an entry proposing an endpoint for the project’s API catalog (#2192); approving it writes the endpoint. Mutually exclusive with the other kinds.

object
apiId

The API it is for; left out, the project’s only one (or none yet). With several APIs it is named (400 api_required)

string
method
required

Upper or lower case; stored upper case

string
Allowed values: GET PUT POST DELETE OPTIONS HEAD PATCH TRACE
path
required

A path TEMPLATE: it starts with /, a parameter is a whole segment written {name}, and a segment that names one thing - digits, a UUID, a long hex run, anything with @ - is refused: write it as a parameter. No query, no fragment.

string
>= 1 characters <= 512 characters
source
required
string
Allowed values: spec code traffic
trust

derived when left out; approving says the endpoint belongs in the catalog, not that its description is right

string
Allowed values: confirmed derived
summary
string
>= 1 characters <= 500 characters
auth

The auth scheme names it asks for, as a spec names them; [] is public

Array<string>
<= 10 items
environment

Where the agent saw it

string
>= 1 characters <= 100 characters
seenAt

When the agent saw it; a time ahead of the server is taken as the moment of the approval

string format: date-time
automation

Present on an automation proposal (#2201, ADR 0080) - code an agent wrote for a case; a person approving it in a session writes the case’s code snapshot. Mutually exclusive with the other kinds.

object
testCaseId
required
string
caseTitle
required
string
caseType
required
string
Allowed values: manual automated
caseSteps
integer
caseFile
required
string
snapshot
string
specRef
required
string
files
required
Array<object>
<= 10 items
object
path
required
string
content
required

At most 16 384 bytes.

string
refused
required
Array<object>
<= 10 items
object
path
required
string
bytes
required
integer
reason
required
string
Allowed values: too-big path binary
baseHash
string
origin
required
object
tool
required
string
version
required
string
cliVersion
string
runCost

What a RUN cost — never what one proposal cost. Both numbers are required together because one alone says nothing: a token count is a fact only once you know how many cases it bought. Zero is a report; a run that did not count omits the object entirely.

object
tokens
required
integer
cases
required
integer
link
string
snapshotHash
string
approvedBy
string
approvedAt
string format: date-time
answer

The person’s answer to question, once given: an answered question is approved, and an approved question always has one.

object
text

Trimmed.

string
>= 1 characters <= 2000 characters
option

The index into question.options.

integer
access

What the person gives, each kind once, all of them among question.access.

Array<string>
>= 1 items <= 4 items
Allowed values: openapi repo staging har
action

#2195: the action of a failure question the person picks; this answer carries it out.

string
Allowed values: file-bug accept-fix expected-change quarantine
by
required

The user id of the person who answered.

string
at
required
string format: date-time
category

failure (#2195): the question’s category, beside the chosen action - what project memory reads.

string
Allowed values: app-bug selector timing data environment dependency covered-by-overlay ambiguous-locator dead-click
outcome

failure, with an action: what it did - the bug filed or added to (bugId), or the case changed (testCaseId).

object
bugId
string
testCaseId
string
answering

#2195: an answer whose action is being carried out right now, on a question that is still pending. While it runs, any PATCH and another answer are a 409 answer_in_progress. Gone once the answer settles (the question approved, with answer) or is refused (the question waits as before). The hold is renewed while the action runs; one not renewed for 5 minutes, its process taken to have died, is not shown and holds nothing. With outcome it never runs out: the action is committed and does not run again, and the next answer ends the question from it - 200 for the same action; another answer or a rejection ends it too and is a 409 already_decided. Approving it is a 409 answer_required, and a note or any other PATCH is a 409 answer_in_progress: neither ends it. It takes its place under the queue’s ceiling until one of them comes.

object
by
required

Who is answering.

string
at
required

When the answer began.

string format: date-time
action
required

The action being carried out.

string
Allowed values: file-bug accept-fix expected-change quarantine
outcome

The action is done, and only settling the question is missing: what it did, as answer.outcome will say.

object
bugId
string
testCaseId
string
strategy

Present on an entry proposing a mission’s test strategy (#2190), or the project’s test plan (projectId, #2741). Mutually exclusive with the other kinds. Approving it makes the next version of that strategy or plan.

object
missionId

The mission the strategy is for

string
projectId

#2741: the project whose test plan this is

string
content
required

A test plan in the sections of ISTQB CTFL v4.0.1 (ADR 0074).

object
objectives
required

What the testing is for

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
scope
required
object
in
required

What is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
out
required

What is deliberately NOT tested, and why - required

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
approach
required

How it is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
profile
required

The methodology profile of the project (ADR 0074 §2)

object
levels
required

Test levels, CTFL v4.0.1 §2.2.1

Array<string>
>= 1 items unique items
Allowed values: component component-integration system system-integration acceptance
characteristics
required

Quality characteristics, ISO/IEC 25010:2023

Array<string>
>= 1 items unique items
Allowed values: functional-suitability performance-efficiency compatibility interaction-capability reliability security maintainability flexibility safety
techniques
required

Test techniques, CTFL v4.0.1 §4.2-§4.4

Array<string>
>= 1 items unique items
Allowed values: equivalence-partitioning boundary-value decision-table state-transition statement branch error-guessing exploratory checklist
split
required

Per cent by API, UI and by hand; 100 in all

object
api
required
integer
<= 100
ui
required
integer
<= 100
manual
required
integer
<= 100
notes
required

Why these levels, characteristics and techniques

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
risks
required
Array<object>
>= 1 items <= 50 items

A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
likelihood
required
string
Allowed values: low medium high
impact
required
string
Allowed values: low medium high
caseIds

Live cases of the project that cover it (checked)

Array<string>
<= 50 items unique items
requirementIds

Requirements of the project it is about (checked); their cases are in the matrix

Array<string>
<= 50 items unique items
entryCriteria
required

When the testing can start

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
exitCriteria
required

When it is done

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
testPlanVersion

A mission’s proposal only: the version of the project’s test plan the plan was taken from (POST /v1/missions/{id}/strategy/from-test-plan, #2740); absent for a written plan

integer
>= 1
editedStrategy

A person’s corrected plan (#2190, PUT /v1/review-items/{id}/strategy), beside strategy, which stays what the agent said; approving takes it. editedBy / editedAt say who and when.

object
objectives
required

What the testing is for

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
scope
required
object
in
required

What is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
out
required

What is deliberately NOT tested, and why - required

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
approach
required

How it is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
profile
required

The methodology profile of the project (ADR 0074 §2)

object
levels
required

Test levels, CTFL v4.0.1 §2.2.1

Array<string>
>= 1 items unique items
Allowed values: component component-integration system system-integration acceptance
characteristics
required

Quality characteristics, ISO/IEC 25010:2023

Array<string>
>= 1 items unique items
Allowed values: functional-suitability performance-efficiency compatibility interaction-capability reliability security maintainability flexibility safety
techniques
required

Test techniques, CTFL v4.0.1 §4.2-§4.4

Array<string>
>= 1 items unique items
Allowed values: equivalence-partitioning boundary-value decision-table state-transition statement branch error-guessing exploratory checklist
split
required

Per cent by API, UI and by hand; 100 in all

object
api
required
integer
<= 100
ui
required
integer
<= 100
manual
required
integer
<= 100
notes
required

Why these levels, characteristics and techniques

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
risks
required
Array<object>
>= 1 items <= 50 items

A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
likelihood
required
string
Allowed values: low medium high
impact
required
string
Allowed values: low medium high
caseIds

Live cases of the project that cover it (checked)

Array<string>
<= 50 items unique items
requirementIds

Requirements of the project it is about (checked); their cases are in the matrix

Array<string>
<= 50 items unique items
entryCriteria
required

When the testing can start

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
exitCriteria
required

When it is done

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
report

Present on an entry carrying a mission’s completion report (#2193), as the server built it. Mutually exclusive with the other kinds. Approving it makes the next version of the mission’s report.

object
missionId
required
string
strategyVersion
required
integer
>= 1
since
required

When the mission began: results and bugs count from here

string format: date-time
generatedAt
required
string format: date-time
totals
required
object
risks
required
integer
covered
required

Risks with a case executed since the mission began

integer
passed
required
integer
failed
required
integer
notRun
required
integer
noCases
required
integer
defects
required
integer
failures
required
integer
risks
required
Array<object>
<= 200 items
object
index
required

In the strategy’s risks

integer
text
required
string
level
required
integer
>= 1 <= 9
priority
required
string
Allowed values: low medium high
coverage
required
string
Allowed values: failed passed not-run no-cases
cases
required
Array<object>
<= 200 items
object
testCaseId
required
string
title
required
string
status
required

The latest result since the mission began; null: not run since

string
nullable
Allowed values: passed failed broken blocked skipped
runId
required
string
nullable
at
required
string format: date-time
nullable
found
required
object
defects
required
Array<object>
<= 200 items
object
bugId
required
string
number
required
integer
title
required
string
state
required
string
Allowed values: open closed
failures
required
Array<object>
<= 200 items
object
testCaseId
required
string
title
required
string
status
required

The latest result since the mission began; null: not run since

string
nullable
Allowed values: passed failed broken blocked skipped
runId
required
string
nullable
at
required
string format: date-time
nullable
deadClicks
required

Not reported: Cairn does not send them to the platform yet

object
reported
required
boolean
reason
required
string
ambiguousElements
required

Not reported: Cairn does not send them to the platform yet

object
reported
required
boolean
reason
required
string
notTested
required
object
outOfScope
required

What the strategy deliberately left out, and why

Array<object>
<= 200 items
object
text
required
string
uncovered
required
Array<object>
<= 200 items
object
index
required
integer
text
required
string
why
required
string
Allowed values: no-cases not-run
openQuestions
required
Array<object>
<= 200 items
object
questionId
required
string
text
required
string
waiting
required
Array<object>
<= 200 items
object
path
required
string
questionId
required
string
lessons
required

Answered plain questions of the mission - candidates for the project’s memory (E7)

Array<object>
<= 200 items
object
questionId
required
string
question
required
string
answer
required
string
state
required

changes_requested (#1276): a reviewer asked the author for changes (changeRequest says what). It is the item’s own state, not a mark on a reviewer: it cannot be approved until the author re-submits, which puts the item back to pending.

string
Allowed values: pending changes_requested approved rejected
revision

Raised by every re-submission; absent is 1. An approval counts only for the revision it was given on.

integer
>= 1
yours

On GET /v1/review-items/{id} only (#2200): the caller put the entry in the queue. The review policy refuses the author some decisions (approving without self-merge, asking for changes). Absent for anyone else and on the list.

boolean
reviewers

The user ids asked to review the item - the project’s default reviewer, when they could be asked.

Array<string>
defaultReviewerSkipped

The default reviewer who was NOT asked because they no longer have the right to review - the list says who was passed over.

string
approvals

Who approved which revision; the policy’s approvalsRequired counts those of the current revision.

Array<object>
object
userId
required
string
at
required
string format: date-time
revision
required
integer
changeRequest

The open request for changes (present with state: changes_requested); the author’s re-submission clears it.

object
by
required
string
at
required
string format: date-time
note
required
string
revision
required
integer
rejectionCategory

Present on every item rejected after R4, and absent forever on rejections stored before it — those are never migrated and must keep reading without error. An item that is pending or approved usually has none, but MAY still carry one: a rejection returned to review keeps the pair in the row as a draft, and the next move to rejected must supply it in the request anyway. Read it as “meaningful only while state is rejected”, not as “absent otherwise”.

string
Allowed values: duplicate incorrect out-of-scope low-value not-testable other
note
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"schemaVersion": 1,
"proposedCase": {
"execution": "auto",
"origin": {
"mode": "explore"
},
"source": {
"kind": "url"
},
"lint": [
{
"rule": "title-vague"
}
],
"verdict": "passed",
"externalKeys": [
{
"kind": "playwright-id"
}
]
},
"discoveredTest": {
"keys": [
{
"kind": "playwright-id"
}
]
},
"question": {
"template": "plain",
"access": [
"openapi"
],
"category": "app-bug",
"actions": [
{
"kind": "file-bug"
}
]
},
"proposedEndpoint": {
"method": "GET",
"path": "/orders/{orderId}",
"source": "spec",
"trust": "confirmed"
},
"automation": {
"caseType": "manual",
"refused": [
{
"reason": "too-big"
}
]
},
"answer": {
"access": [
"openapi"
],
"action": "file-bug",
"category": "app-bug"
},
"answering": {
"action": "file-bug"
},
"strategy": {
"content": {
"objectives": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"scope": {
"in": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"out": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
},
"approach": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"profile": {
"levels": [
"component"
],
"characteristics": [
"functional-suitability"
],
"techniques": [
"equivalence-partitioning"
],
"notes": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
},
"risks": [
{
"source": {
"kind": "mission-source"
},
"assumption": true,
"likelihood": "low",
"impact": "low"
}
],
"entryCriteria": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"exitCriteria": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
}
},
"editedStrategy": {
"objectives": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"scope": {
"in": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"out": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
},
"approach": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"profile": {
"levels": [
"component"
],
"characteristics": [
"functional-suitability"
],
"techniques": [
"equivalence-partitioning"
],
"notes": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
},
"risks": [
{
"source": {
"kind": "mission-source"
},
"assumption": true,
"likelihood": "low",
"impact": "low"
}
],
"entryCriteria": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
],
"exitCriteria": [
{
"source": {
"kind": "mission-source"
},
"assumption": true
}
]
},
"report": {
"risks": [
{
"priority": "low",
"coverage": "failed",
"cases": [
{
"status": "passed"
}
]
}
],
"found": {
"defects": [
{
"state": "open"
}
],
"failures": [
{
"status": "passed"
}
],
"deadClicks": {
"reported": false
},
"ambiguousElements": {
"reported": false
}
},
"notTested": {
"uncovered": [
{
"why": "no-cases"
}
]
}
},
"state": "pending",
"yours": true,
"rejectionCategory": "duplicate"
}

Queued, pending

Media type application/json

One entry of the review queue. Always starts pending; a reviewer moves it on.

object
schemaVersion
required
integer
Allowed values: 1
id
required
string format: uuid
resultId

Present on an entry disputing a RESULT. Exactly one of resultId, proposedCase, discoveredTest, question, proposedEndpoint, strategy, report, memoryRule and automation is present: an entry with two asks two questions at once, and one with none asks nothing.

string format: uuid
proposedCase

Present on an entry proposing a new case. Mutually exclusive with the other kinds.

object
stableId
required

Content-derived identity; the dedup key.

string
title
required
string
<= 300 characters
execution
required
string
Allowed values: auto manual
steps
required
Array<string>
>= 1 items <= 20 items
expected
required
string
<= 2000 characters
origin
required
One of:
object
runId
required
string
mode
required
string
Allowed values: explore design api mcp
target
required
string
technique
string
<= 32 characters
priority
string
source
object
kind
required
string
Allowed values: url openapi-operation requirement pasted-text jira-ticket
value
required
string
>= 1 characters <= 100 characters
rationale
string
>= 1 characters <= 400 characters
lint

What the pre-review checks found, written before the proposal was queued (#1289). It marks the proposal. Only placeholder stops anything: a proposal whose title, steps or expected result still holds {{...}}, [TODO]/[TBD]/[FIXME]/[XXX] (or the same in <...>) or a run of three or more underscores cannot be approved (409 naming the places), and that check is read off the reviewer’s edited version when there is one. Absent means nothing was found.

Array<object>
object
rule
required
string
Allowed values: title-vague step-empty expected-vague duplicate-case duplicate-proposal placeholder
message
required
string
url
required

Where the rule is explained.

string
runCost
object
tokens
required
integer
cases
required
integer
verdict

Absent means never executed — NOT “no result yet”. blocked: no answer from the target.

string
Allowed values: passed failed blocked
externalKeys

What a match resolves through. Absent is a normal proposal, not a degraded one: an agent that names no key gets an entry with no comparison, which is exactly what a genuinely new case gets.

Array<object>
<= 32 items

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
editedCase

The reviewer’s corrected version of the proposal (#1878), beside proposedCase, which stays what the agent said. Present only after an edit; approving the item makes the case from it. Left off the page of the listing (editedBy and editedAt stay).

object
title
required
string
<= 300 characters
steps
required
Array<string>
>= 1 items <= 20 items
expected
required
string
<= 2000 characters
editedBy

The user id of whoever saved the version in editedCase.

string
editedAt

When editedCase was saved.

string format: date-time
discoveredTest

Present on an entry reporting a test the caller RUNS and this project has no case for. Mutually exclusive with the other kinds.

object
keys
required

The identity. Order does not matter — the server ranks them and the highest-ranked kind is what deduplication reads, so two adapters sending the same keys in a different order do not produce two entries about one test.

Array<object>
>= 1 items <= 8 items

An identifier another tool already uses for this test, so a report can find its case without anyone typing a Plune id. The order of kind is load-bearing: it is the ranking that decides which key wins when several match different cases.

object
kind
required
string
Allowed values: playwright-id path-title allure-history cairn-stable eval-id qase testrail testomat zephyr
value
required
string
<= 1024 characters
title
required
string
<= 300 characters
source
required

The reporter that found it, e.g. playwright.

string
<= 32 characters
specRef
required

Where the test lives, e.g. e2e/checkout.spec.ts:12. Required while everything descriptive is optional: an approved discovery becomes an automated case, and that shape needs a spec to point at.

string
<= 400 characters
rawStatus

What it did on this run, in the reporter’ own word.

string
<= 64 characters
platformRunId

The run that turned it up, once stored.

string
question

Present on an entry asking a person a question (#2189). Mutually exclusive with the other kinds.

object
template
required
string
Allowed values: plain access failure
text
required

Trimmed. On failure, the explanation: at most 500 characters.

string
>= 1 characters <= 2000 characters
missionId

The mission the question is about (#2188), one of this project’s: another project’s, or one nobody made, is a 404 mission not found.

string
options

plain only. Each trimmed; no two the same.

Array<string>
>= 1 items <= 3 items
access

access only, and required there; each kind once. openapi: an API description (OpenAPI or Postman); repo: read-only access to the code; staging: a staging host with a test account; har: a HAR file.

Array<string>
>= 1 items <= 4 items
Allowed values: openapi repo staging har
resultId

failure only, and required there: a result of this project in a live run, failed or broken, of a live case. Another project’s, or one nobody made, is a 404; one that did not fail is a 409 result_not_failed; a second waiting question on one result is a 409 already_asked. GET /v1/review-items?resultId= finds the question for the result’s page.

string
testCaseId

failure only: the case of the result, read off the result by the server - never sent (a body that names it is a 400).

string
category

failure only, and required there: why the test failed. app-bug the application; selector, timing, data, environment, dependency; and Cairn’s covered-by-overlay, ambiguous-locator, dead-click. Copied onto the answer.

string
Allowed values: app-bug selector timing data environment dependency covered-by-overlay ambiguous-locator dead-click
actions

failure only, and required there: one to three actions, each kind once. A page of the queue carries a fix without its code (codeGiven: true).

Array<object>
>= 1 items <= 3 items

An action a failure question offers (#2195), carried out by the answer that picks it (answer.action), as the person who answered. file-bug: a bug from the result, titled title, its case linked and the result its evidence - or, with bugId, the result added as evidence to that bug of the project (one of the two). accept-fix: the case’s code (codeSnapshot) becomes code; automated cases only (else 400 action_not_for_case). expected-change: the product changed on purpose - a manual case’s expected result becomes expected, an automated case’s code becomes code. quarantine: the case is muted, and its results in open runs count as muted. baseHash (sha256 hex of the code the fix was written against): when given and the case’s code has moved since, the answer is a 409 code_changed.

object
kind
required
string
Allowed values: file-bug accept-fix expected-change quarantine
title

file-bug: the title of the bug to file.

string
>= 1 characters <= 200 characters
bugId

file-bug: a live bug of the project the result is added to; another one is a 404.

string
code

accept-fix, expected-change: the whole fixed test() call, at most 16 384 bytes.

string
>= 1 characters
expected

expected-change on a manual case: its new expected result.

string
>= 1 characters <= 2000 characters
baseHash
string
/^[0-9a-f]{64}$/
codeGiven

On a page of the queue, in place of code.

boolean
proposedEndpoint

Present on an entry proposing an endpoint for the project’s API catalog (#2192); approving it writes the endpoint. Mutually exclusive with the other kinds.

object
apiId

The API it is for; left out, the project’s only one (or none yet). With several APIs it is named (400 api_required)

string
method
required

Upper or lower case; stored upper case

string
Allowed values: GET PUT POST DELETE OPTIONS HEAD PATCH TRACE
path
required

A path TEMPLATE: it starts with /, a parameter is a whole segment written {name}, and a segment that names one thing - digits, a UUID, a long hex run, anything with @ - is refused: write it as a parameter. No query, no fragment.

string
>= 1 characters <= 512 characters
source
required
string
Allowed values: spec code traffic
trust

derived when left out; approving says the endpoint belongs in the catalog, not that its description is right

string
Allowed values: confirmed derived
summary
string
>= 1 characters <= 500 characters
auth

The auth scheme names it asks for, as a spec names them; [] is public

Array<string>
<= 10 items
environment

Where the agent saw it

string
>= 1 characters <= 100 characters
seenAt

When the agent saw it; a time ahead of the server is taken as the moment of the approval

string format: date-time
automation

Present on an automation proposal (#2201, ADR 0080) - code an agent wrote for a case; a person approving it in a session writes the case’s code snapshot. Mutually exclusive with the other kinds.

object
testCaseId
required
string
caseTitle
required
string
caseType
required
string
Allowed values: manual automated
caseSteps
integer
caseFile
required
string
snapshot
string
specRef
required
string
files
required
Array<object>
<= 10 items
object
path
required
string
content
required

At most 16 384 bytes.

string
refused
required
Array<object>
<= 10 items
object
path
required
string
bytes
required
integer
reason
required
string
Allowed values: too-big path binary
baseHash
string
origin
required
object
tool
required
string
version
required
string
cliVersion
string
runCost

What a RUN cost — never what one proposal cost. Both numbers are required together because one alone says nothing: a token count is a fact only once you know how many cases it bought. Zero is a report; a run that did not count omits the object entirely.

object
tokens
required
integer
cases
required
integer
link
string
snapshotHash
string
approvedBy
string
approvedAt
string format: date-time
answer

The person’s answer to question, once given: an answered question is approved, and an approved question always has one.

object
text

Trimmed.

string
>= 1 characters <= 2000 characters
option

The index into question.options.

integer
access

What the person gives, each kind once, all of them among question.access.

Array<string>
>= 1 items <= 4 items
Allowed values: openapi repo staging har
action

#2195: the action of a failure question the person picks; this answer carries it out.

string
Allowed values: file-bug accept-fix expected-change quarantine
by
required

The user id of the person who answered.

string
at
required
string format: date-time
category

failure (#2195): the question’s category, beside the chosen action - what project memory reads.

string
Allowed values: app-bug selector timing data environment dependency covered-by-overlay ambiguous-locator dead-click
outcome

failure, with an action: what it did - the bug filed or added to (bugId), or the case changed (testCaseId).

object
bugId
string
testCaseId
string
answering

#2195: an answer whose action is being carried out right now, on a question that is still pending. While it runs, any PATCH and another answer are a 409 answer_in_progress. Gone once the answer settles (the question approved, with answer) or is refused (the question waits as before). The hold is renewed while the action runs; one not renewed for 5 minutes, its process taken to have died, is not shown and holds nothing. With outcome it never runs out: the action is committed and does not run again, and the next answer ends the question from it - 200 for the same action; another answer or a rejection ends it too and is a 409 already_decided. Approving it is a 409 answer_required, and a note or any other PATCH is a 409 answer_in_progress: neither ends it. It takes its place under the queue’s ceiling until one of them comes.

object
by
required

Who is answering.

string
at
required

When the answer began.

string format: date-time
action
required

The action being carried out.

string
Allowed values: file-bug accept-fix expected-change quarantine
outcome

The action is done, and only settling the question is missing: what it did, as answer.outcome will say.

object
bugId
string
testCaseId
string
strategy

Present on an entry proposing a mission’s test strategy (#2190), or the project’s test plan (projectId, #2741). Mutually exclusive with the other kinds. Approving it makes the next version of that strategy or plan.

object
missionId

The mission the strategy is for

string
projectId

#2741: the project whose test plan this is

string
content
required

A test plan in the sections of ISTQB CTFL v4.0.1 (ADR 0074).

object
objectives
required

What the testing is for

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
scope
required
object
in
required

What is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
out
required

What is deliberately NOT tested, and why - required

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
approach
required

How it is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
profile
required

The methodology profile of the project (ADR 0074 §2)

object
levels
required

Test levels, CTFL v4.0.1 §2.2.1

Array<string>
>= 1 items unique items
Allowed values: component component-integration system system-integration acceptance
characteristics
required

Quality characteristics, ISO/IEC 25010:2023

Array<string>
>= 1 items unique items
Allowed values: functional-suitability performance-efficiency compatibility interaction-capability reliability security maintainability flexibility safety
techniques
required

Test techniques, CTFL v4.0.1 §4.2-§4.4

Array<string>
>= 1 items unique items
Allowed values: equivalence-partitioning boundary-value decision-table state-transition statement branch error-guessing exploratory checklist
split
required

Per cent by API, UI and by hand; 100 in all

object
api
required
integer
<= 100
ui
required
integer
<= 100
manual
required
integer
<= 100
notes
required

Why these levels, characteristics and techniques

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
risks
required
Array<object>
>= 1 items <= 50 items

A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
likelihood
required
string
Allowed values: low medium high
impact
required
string
Allowed values: low medium high
caseIds

Live cases of the project that cover it (checked)

Array<string>
<= 50 items unique items
requirementIds

Requirements of the project it is about (checked); their cases are in the matrix

Array<string>
<= 50 items unique items
entryCriteria
required

When the testing can start

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
exitCriteria
required

When it is done

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
testPlanVersion

A mission’s proposal only: the version of the project’s test plan the plan was taken from (POST /v1/missions/{id}/strategy/from-test-plan, #2740); absent for a written plan

integer
>= 1
editedStrategy

A person’s corrected plan (#2190, PUT /v1/review-items/{id}/strategy), beside strategy, which stays what the agent said; approving takes it. editedBy / editedAt say who and when.

object
objectives
required

What the testing is for

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
scope
required
object
in
required

What is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
out
required

What is deliberately NOT tested, and why - required

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
approach
required

How it is tested

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
profile
required

The methodology profile of the project (ADR 0074 §2)

object
levels
required

Test levels, CTFL v4.0.1 §2.2.1

Array<string>
>= 1 items unique items
Allowed values: component component-integration system system-integration acceptance
characteristics
required

Quality characteristics, ISO/IEC 25010:2023

Array<string>
>= 1 items unique items
Allowed values: functional-suitability performance-efficiency compatibility interaction-capability reliability security maintainability flexibility safety
techniques
required

Test techniques, CTFL v4.0.1 §4.2-§4.4

Array<string>
>= 1 items unique items
Allowed values: equivalence-partitioning boundary-value decision-table state-transition statement branch error-guessing exploratory checklist
split
required

Per cent by API, UI and by hand; 100 in all

object
api
required
integer
<= 100
ui
required
integer
<= 100
manual
required
integer
<= 100
notes
required

Why these levels, characteristics and techniques

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
risks
required
Array<object>
>= 1 items <= 50 items

A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
likelihood
required
string
Allowed values: low medium high
impact
required
string
Allowed values: low medium high
caseIds

Live cases of the project that cover it (checked)

Array<string>
<= 50 items unique items
requirementIds

Requirements of the project it is about (checked); their cases are in the matrix

Array<string>
<= 50 items unique items
entryCriteria
required

When the testing can start

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
exitCriteria
required

When it is done

Array<object>
>= 1 items <= 25 items

One item of a strategy. Exactly one of source, assumption, waitingOn - none, or two, and the strategy does not pass its checks (strategy_lint).

object
text
required

Markdown

string
>= 1 characters <= 1000 characters
source

Where an item was read. mission-source: the id of a source of this mission; requirement: the id of a requirement of the project (both checked); doc-section (docs/checkout.md#payment), screen (SCR-03 Cart), endpoint (POST /cart), url: a place in words a person can follow.

object
kind
required
string
Allowed values: mission-source doc-section screen endpoint requirement url
ref
required
string
>= 1 characters <= 300 characters
assumption

«припущення, підтвердіть»: the agent assumed it and asks a person to confirm

boolean
waitingOn

The id of a question of this mission (a review item) whose answer this part waits for; the text says what waits, never a guessed answer

string
report

Present on an entry carrying a mission’s completion report (#2193), as the server built it. Mutually exclusive with the other kinds. Approving it makes the next version of the mission’s report.

object
missionId
required
string
strategyVersion
required
integer
>= 1
since
required

When the mission began: results and bugs count from here

string format: date-time
generatedAt
required
string format: date-time
totals
required
object
risks
required
integer
covered
required

Risks with a case executed since the mission began

integer
passed
required
integer
failed
required
integer
notRun
required
integer
noCases
required
integer
defects
required
integer
failures
required
integer
risks
required
Array<object>
<= 200 items
object
index
required

In the strategy’s risks

integer
text
required
string
level
required
integer
>= 1 <= 9
priority
required
string
Allowed values: low medium high
coverage
required
string
Allowed values: failed passed not-run no-cases
cases
required
Array<object>
<= 200 items
object
testCaseId
required
string
title
required
string
status
required

The latest result since the mission began; null: not run since

string
nullable
Allowed values: passed failed broken blocked skipped
runId
required
string
nullable
at
required
string format: date-time
nullable
found
required
object
defects
required
Array<object>
<= 200 items
object
bugId
required
string
number
required
integer
title
required
string
state
required
string
Allowed values: open closed
failures
required
Array<object>
<= 200 items
object
testCaseId
required
string
title
required
string
status
required

The latest result since the mission began; null: not run since

string
nullable
Allowed values: passed failed broken blocked skipped
runId
required
string
nullable
at
required
string format: date-time
nullable
deadClicks
required

Not reported: Cairn does not send them to the platform yet

object
reported
required
boolean
reason
required
string
ambiguousElements
required

Not reported: Cairn does not send them to the platform yet

object
reported
required
boolean
reason
required
string
notTested
required
object
outOfScope
required

What the strategy deliberately left out, and why

Array<object>
<= 200 items
object
text
required
string
uncovered
required
Array<object>
<= 200 items
object
index
required
integer
text
required
string
why
required
string
Allowed values: no-cases not-run
openQuestions
required
Array<object>
<= 200 items
object
questionId
required
string
text
required
string
waiting
required
Array<object>
<= 200 items
object
path
required
string
questionId
required
string
lessons
required

Answered plain questions of the mission - candidates for the project’s memory (E7)

Array<object>
<= 200 items
object
questionId
required
string
question
required
string
answer
required
string
state
required

changes_requested (#1276): a reviewer asked the author for changes (changeRequest says what). It is the item’s own state, not a mark on a reviewer: it cannot be approved until the author re-submits, which puts the item back to pending.

string
Allowed values: pending changes_requested approved rejected
revision

Raised by every re-submission; absent is 1. An approval counts only for the revision it was given on.

integer
>= 1
yours

On GET /v1/review-items/{id} only (#2200): the caller put the entry in the queue. The review policy refuses the author some decisions (approving without self-merge, asking for changes). Absent for anyone else and on the list.

boolean
reviewers

The user ids asked to review the item - the project’s default reviewer, when they could be asked.

Array<string>
defaultReviewerSkipped

The default reviewer who was NOT asked because they no longer have the right to review - the list says who was passed over.

string
approvals

Who approved which revision; the policy’s approvalsRequired counts those of the current revision.

Array<object>
object
userId
required
string
at
required
string format: date-time
revision
required
integer
changeRequest

The open request for changes (present with state: changes_requested); the author’s re-submission clears it.

object
by
required
string
at
required
string format: date-time
note
required
string
revision
required
integer
rejectionCategory

Present on every item rejected after R4, and absent forever on rejections stored before it — those are never migrated and must keep reading without error. An item that is pending or approved usually has none, but MAY still carry one: a rejection returned to review keeps the pair in the row as a draft, and the next move to rejected must supply it in the request anyway. Read it as “meaningful only while state is rejected”, not as “absent otherwise”.

string
Allowed values: duplicate incorrect out-of-scope low-value not-testable other
note
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"schemaVersion": 1,
"id": "6f1c2b3a-0000-4000-8000-0000000000b1",
"proposedEndpoint": {
"apiId": "4b6f3c1e-8d2a-4f5b-9c7e-1a2b3c4d5e6f",
"method": "GET",
"path": "/orders/{orderId}",
"source": "code",
"trust": "derived",
"summary": "One order"
},
"state": "pending",
"createdAt": "2026-11-04T09:00:00.000Z",
"updatedAt": "2026-11-04T09:00:00.000Z"
}

A body that is not an endpoint; a path that is not a template; with several APIs, no apiId (api_required)

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

You are in the project as a reader, or the token is read-only

No such API in your project

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Two refusals share this status, and what to do about them is opposite. Rate-limited — the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442, #2092): Retry-After carries the seconds until the window rolls over, and waiting that long is the way out. Quota reached — a ceiling on what the project holds (runs in the last 24 hours, test cases, items waiting in the review queue, rules in force in the project’s memory): { error, quota }. A retry straight away frees nothing, so do not loop on it; the message says what makes room — deleting cases, working the queue down, an operator raising the limit — and the run quota, a rolling 24 hours, frees its oldest runs as they age out. Tell the two apart by the body: a 429 whose body has a quota object is a quota, one without it is a throttle. quota carries kind, limit, used, remaining and resetsAt: the figures behind the sentence, and for the run quota the instant its oldest run ages out (#1258). Retry-After is sent on a quota only where there is such an instant (the run quota: the whole seconds, at least 1, until resetsAt); the case, review-queue and project quotas free only by an action, have resetsAt: null, and send no Retry-After. GET /v1/quotas reads the same figures without a refusal.

Media type application/json
One of:
object
error
required
string
Examples

A throttle: no `quota`; wait `Retry-After`

{
"error": "rate limit exceeded — slow down"
}
Retry-After
integer

Seconds until the window rolls over on a throttle; on a quota, until quota.resetsAt — sent only for the run quota, which has one