Skip to content

The shared test documentation - no account

GET
/public/test-docs/{token}
curl --request GET \
--url https://beta-api.plune.ai/public/test-docs/example

The pack frozen when the link was made (#2750), for anyone who holds the address, with no credential and no cookie. Answered as the run’s public report answers: revoked, never made and malformed are one 404; expired is 410 expired; with a password, 401 password_required without it and wrong_password with a wrong one (the X-Report-Password header), 10 wrong a token in 15 minutes, 30 password tries a client a minute, 120 reads a client a minute. Sent with Cache-Control: no-store, X-Robots-Tag: noindex, nofollow and Referrer-Policy: no-referrer.

token
required
string

43 characters of base64url.

X-Report-Password
string

The link’s password, when it has one.

The pack

Media type application/json

The export pack of the test documentation (#2747, ADR 0082 §5; implementation decision D6: its parts are fixed) and the frozen snapshot a public link shows (#2750). No ids and no people. The lists stop at 200; the counts are the whole project, live cases only.

object
project
required
string
madeAt
required
string format: date-time
testPlan
required

The current version; null - none saved yet

object
version
required
integer
>= 1
savedAt
required
string format: date-time
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
riskLevels
required
Array<object>
object
level
required
integer
priority
required
string
coverage
required
object
matrix
required
object
number
required
integer
builtAt
required
string format: date-time
api
required
object
endpoints
required
integer
withCases
required
integer
withoutCases
required
integer
promised
required
object
api
required
integer
ui
required
integer
manual
required
integer
actual
required
object
api
required
integer
nullable
ui
required
integer
manual
required
integer
requirements
required
object
total
required
integer
withAcceptanceCriteria
required
integer
withoutAcceptanceCriteria
required
integer
withoutCases
required
integer
failing
required
integer
notRun
required
integer
items
required
Array<object>
<= 200 items
object
key
required
string
title
required
string
acceptanceCriteria
required
string
nullable
cases
required
integer
health
required
string
Allowed values: failing passing partial notRun noCases
cases
required
object
total
required
integer
fromCode
required
integer
describedFromCode
required
integer
stale
required
integer
byAgent
required
integer
byHand
required
integer
items
required
Array<object>
<= 200 items
object
title
required
string
type
required
string
Allowed values: manual automated eval
source
required
string
Allowed values: code not-code
described
required
boolean
stale
required
boolean
origin
required
string
Allowed values: manual ai-generated ai-edited
Example
{
"testPlan": {
"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
}
]
}
},
"requirements": {
"items": [
{
"health": "failing"
}
]
},
"cases": {
"items": [
{
"type": "manual",
"source": "code",
"origin": "manual"
}
]
}
}

A password is set: none sent (password_required) or a wrong one (wrong_password)

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

No such link

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

The link has expired: code: expired

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

Too many reads or wrong passwords - Retry-After

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