Skip to content

Check a test strategy without proposing it

POST
/v1/missions/{id}/strategy/check
curl --request POST \
--url https://beta-api.plune.ai/v1/missions/example/strategy/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "objectives": [ { "text": "A customer can pay for a cart and gets a receipt", "source": { "kind": "doc-section", "ref": "docs/checkout.md#goal" } } ], "scope": { "in": [ { "text": "The cart, payment by card and by voucher, the receipt email", "source": { "kind": "doc-section", "ref": "docs/checkout.md#scope" } } ], "out": [ { "text": "The warehouse back office: another team owns it and tests it", "source": { "kind": "doc-section", "ref": "docs/checkout.md#out-of-scope" } } ] }, "approach": [ { "text": "The API first, from the OpenAPI file; then the three UI flows of the checkout", "source": { "kind": "endpoint", "ref": "POST /cart" } } ], "profile": { "levels": [ "system", "acceptance" ], "characteristics": [ "functional-suitability", "security" ], "techniques": [ "equivalence-partitioning", "boundary-value", "state-transition" ], "split": { "api": 60, "ui": 30, "manual": 10 }, "notes": [ { "text": "A URL and an OpenAPI file, no repository: no component level", "source": { "kind": "url", "ref": "https://shop.example.com/openapi.json" } } ] }, "risks": [ { "text": "A card is charged twice when the payment page is reloaded", "likelihood": "medium", "impact": "high", "source": { "kind": "endpoint", "ref": "POST /payments" } }, { "text": "A voucher past its date is taken", "likelihood": "low", "impact": "medium", "assumption": true } ], "entryCriteria": [ { "text": "Staging is up and a test account exists", "assumption": true } ], "exitCriteria": [ { "text": "Whether a refunded voucher counts as used", "waitingOn": "6f1c2b3a-0000-4000-8000-000000002190" } ] }'

Runs the checks of POST /v1/missions/{id}/strategy on the same body and writes nothing: 200 { findings: [] } when the strategy would pass, otherwise the same 400 strategy_lint with each finding, or 409 mission_done. The same token and session rules as the proposal. Whether the queue is full or another proposal waits is not checked.

id
required
string

The mission’s id

Media type application/json

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
Example
{
"objectives": [
{
"text": "A customer can pay for a cart and gets a receipt",
"source": {
"kind": "doc-section",
"ref": "docs/checkout.md#goal"
}
}
],
"scope": {
"in": [
{
"text": "The cart, payment by card and by voucher, the receipt email",
"source": {
"kind": "doc-section",
"ref": "docs/checkout.md#scope"
}
}
],
"out": [
{
"text": "The warehouse back office: another team owns it and tests it",
"source": {
"kind": "doc-section",
"ref": "docs/checkout.md#out-of-scope"
}
}
]
},
"approach": [
{
"text": "The API first, from the OpenAPI file; then the three UI flows of the checkout",
"source": {
"kind": "endpoint",
"ref": "POST /cart"
}
}
],
"profile": {
"levels": [
"system",
"acceptance"
],
"characteristics": [
"functional-suitability",
"security"
],
"techniques": [
"equivalence-partitioning",
"boundary-value",
"state-transition"
],
"split": {
"api": 60,
"ui": 30,
"manual": 10
},
"notes": [
{
"text": "A URL and an OpenAPI file, no repository: no component level",
"source": {
"kind": "url",
"ref": "https://shop.example.com/openapi.json"
}
}
]
},
"risks": [
{
"text": "A card is charged twice when the payment page is reloaded",
"likelihood": "medium",
"impact": "high",
"source": {
"kind": "endpoint",
"ref": "POST /payments"
}
},
{
"text": "A voucher past its date is taken",
"likelihood": "low",
"impact": "medium",
"assumption": true
}
],
"entryCriteria": [
{
"text": "Staging is up and a test account exists",
"assumption": true
}
],
"exitCriteria": [
{
"text": "Whether a refunded voucher counts as used",
"waitingOn": "6f1c2b3a-0000-4000-8000-000000002190"
}
]
}

The strategy passes its checks

Media type application/json
object
findings
required
Array
0
Example
{
"findings": []
}

Invalid JSON or body, or code: strategy_lint - the findings of the checks

Media type application/json
object
error
required
string
code
required
string
Allowed values: strategy_lint
findings
required
Array<object>
object
rule
required
string
Allowed values: source-missing basis-ambiguous question-unknown mission-source-unknown requirement-unknown case-unknown
path
required

Where: approach[0], scope.out[1], risks[2].caseIds[0]

string
message
required
string
Example
{
"error": "the strategy does not pass its checks",
"code": "strategy_lint",
"findings": [
{
"rule": "source-missing",
"path": "approach[0]",
"message": "name where this was read (source), mark it as an assumption to confirm, or say which question it waits on"
}
]
}

No / invalid token or session

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

No such mission in your project (code: mission_not_found)

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

The mission is done (mission_done)

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

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

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

Seconds until the window rolls over