Save the project’s test plan as a new version
const url = 'https://beta-api.plune.ai/v1/projects/example/test-plan';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"content":{"objectives":[{"text":"A customer can find, buy and return a product without help","source":{"kind":"doc-section","ref":"docs/product.md#goals"}}],"scope":{"in":[{"text":"The shop: search, the cart, checkout, returns and the account","source":{"kind":"doc-section","ref":"docs/product.md#scope"}}],"out":[{"text":"The warehouse back office: another team owns it and tests it","source":{"kind":"doc-section","ref":"docs/product.md#out-of-scope"}}]},"approach":[{"text":"Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed","assumption":true}],"profile":{"levels":["component-integration","system","acceptance"],"characteristics":["functional-suitability","security","performance-efficiency"],"techniques":["equivalence-partitioning","boundary-value","exploratory"],"split":{"api":50,"ui":30,"manual":20},"notes":[{"text":"The services have their own unit tests in their repositories; this plan starts at their integration","source":{"kind":"url","ref":"https://shop.example.com/docs/testing"}}]},"risks":[{"text":"A card is charged twice when the payment page is reloaded","likelihood":"medium","impact":"high","source":{"kind":"endpoint","ref":"POST /payments"}}],"entryCriteria":[{"text":"A release candidate is on staging with its release notes","assumption":true}],"exitCriteria":[{"text":"No open bug of high priority; every high risk has a passing case","source":{"kind":"doc-section","ref":"docs/product.md#release"}}]},"baseVersion":0}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://beta-api.plune.ai/v1/projects/example/test-plan \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "content": { "objectives": [ { "text": "A customer can find, buy and return a product without help", "source": { "kind": "doc-section", "ref": "docs/product.md#goals" } } ], "scope": { "in": [ { "text": "The shop: search, the cart, checkout, returns and the account", "source": { "kind": "doc-section", "ref": "docs/product.md#scope" } } ], "out": [ { "text": "The warehouse back office: another team owns it and tests it", "source": { "kind": "doc-section", "ref": "docs/product.md#out-of-scope" } } ] }, "approach": [ { "text": "Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed", "assumption": true } ], "profile": { "levels": [ "component-integration", "system", "acceptance" ], "characteristics": [ "functional-suitability", "security", "performance-efficiency" ], "techniques": [ "equivalence-partitioning", "boundary-value", "exploratory" ], "split": { "api": 50, "ui": 30, "manual": 20 }, "notes": [ { "text": "The services have their own unit tests in their repositories; this plan starts at their integration", "source": { "kind": "url", "ref": "https://shop.example.com/docs/testing" } } ] }, "risks": [ { "text": "A card is charged twice when the payment page is reloaded", "likelihood": "medium", "impact": "high", "source": { "kind": "endpoint", "ref": "POST /payments" } } ], "entryCriteria": [ { "text": "A release candidate is on staging with its release notes", "assumption": true } ], "exitCriteria": [ { "text": "No open bug of high priority; every high risk has a passing case", "source": { "kind": "doc-section", "ref": "docs/product.md#release" } } ] }, "baseVersion": 0 }'Saves the plan as the next version; the earlier ones never change. The plan passes the checks of a mission’s strategy (strategy_lint), except that it names no mission: a mission-source source and a waitingOn question are refused (mission-source-unknown, question-unknown); a requirement or a case it names is one of this project’s. Send baseVersion - the version the person edited - and a save that came in since is a 409 test_plan_stale rather than a plan written over. A person who is not a reader, or a write token; an agent proposes a plan through the review queue instead (403 agent_proposes). Written to the project’s feed (testPlan with the version). A mission takes it as a proposal of its strategy on request (POST /v1/missions/{id}/strategy/from-test-plan). Sixty a minute.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The project’s id
Request Body required
Section titled “Request Body required ”object
A test plan in the sections of ISTQB CTFL v4.0.1 (ADR 0074).
object
What the testing is for
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
object
What is tested
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
What is deliberately NOT tested, and why - required
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
How it is tested
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
The methodology profile of the project (ADR 0074 §2)
object
Test levels, CTFL v4.0.1 §2.2.1
Quality characteristics, ISO/IEC 25010:2023
Test techniques, CTFL v4.0.1 §4.2-§4.4
Per cent by API, UI and by hand; 100 in all
object
Why these levels, characteristics and techniques
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.
object
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
Live cases of the project that cover it (checked)
Requirements of the project it is about (checked); their cases are in the matrix
When the testing can start
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
When it is done
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
The version the person edited (0: the project had none). When another save came in since, the answer is a 409 test_plan_stale and nothing is saved. Left out, the save is not checked against one
Examples
The first plan of the project
{ "content": { "objectives": [ { "text": "A customer can find, buy and return a product without help", "source": { "kind": "doc-section", "ref": "docs/product.md#goals" } } ], "scope": { "in": [ { "text": "The shop: search, the cart, checkout, returns and the account", "source": { "kind": "doc-section", "ref": "docs/product.md#scope" } } ], "out": [ { "text": "The warehouse back office: another team owns it and tests it", "source": { "kind": "doc-section", "ref": "docs/product.md#out-of-scope" } } ] }, "approach": [ { "text": "Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed", "assumption": true } ], "profile": { "levels": [ "component-integration", "system", "acceptance" ], "characteristics": [ "functional-suitability", "security", "performance-efficiency" ], "techniques": [ "equivalence-partitioning", "boundary-value", "exploratory" ], "split": { "api": 50, "ui": 30, "manual": 20 }, "notes": [ { "text": "The services have their own unit tests in their repositories; this plan starts at their integration", "source": { "kind": "url", "ref": "https://shop.example.com/docs/testing" } } ] }, "risks": [ { "text": "A card is charged twice when the payment page is reloaded", "likelihood": "medium", "impact": "high", "source": { "kind": "endpoint", "ref": "POST /payments" } } ], "entryCriteria": [ { "text": "A release candidate is on staging with its release notes", "assumption": true } ], "exitCriteria": [ { "text": "No open bug of high priority; every high risk has a passing case", "source": { "kind": "doc-section", "ref": "docs/product.md#release" } } ] }, "baseVersion": 0}The next version, on top of version 1
{ "content": { "objectives": [ { "text": "A customer can find, buy and return a product without help", "source": { "kind": "doc-section", "ref": "docs/product.md#goals" } } ], "scope": { "in": [ { "text": "The shop: search, the cart, checkout, returns and the account", "source": { "kind": "doc-section", "ref": "docs/product.md#scope" } } ], "out": [ { "text": "The warehouse back office: another team owns it and tests it", "source": { "kind": "doc-section", "ref": "docs/product.md#out-of-scope" } } ] }, "approach": [ { "text": "Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed", "assumption": true } ], "profile": { "levels": [ "component-integration", "system", "acceptance" ], "characteristics": [ "functional-suitability", "security", "performance-efficiency" ], "techniques": [ "equivalence-partitioning", "boundary-value", "exploratory" ], "split": { "api": 50, "ui": 30, "manual": 20 }, "notes": [ { "text": "The services have their own unit tests in their repositories; this plan starts at their integration", "source": { "kind": "url", "ref": "https://shop.example.com/docs/testing" } } ] }, "risks": [ { "text": "A card is charged twice when the payment page is reloaded", "likelihood": "medium", "impact": "high", "source": { "kind": "endpoint", "ref": "POST /payments" } } ], "entryCriteria": [ { "text": "A release candidate is on staging with its release notes", "assumption": true } ], "exitCriteria": [ { "text": "No open bug of high priority; every high risk has a passing case", "source": { "kind": "doc-section", "ref": "docs/product.md#release" } } ] }, "baseVersion": 1}Responses
Section titled “ Responses ”The saved version
object
Counts from 1 per project; the highest is the current plan
The person who saved it, or the person whose token did
The earlier version a restore copied; null for a save
The queue entry it was accepted from (#2741); null for a person’s own save, or once the entry is gone. savedBy is then who accepted it
Who put it in the queue: the person, or the person whose token the agent used
The person who corrected the agent’s plan before accepting it
A test plan in the sections of ISTQB CTFL v4.0.1 (ADR 0074).
object
What the testing is for
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
object
What is tested
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
What is deliberately NOT tested, and why - required
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
How it is tested
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
The methodology profile of the project (ADR 0074 §2)
object
Test levels, CTFL v4.0.1 §2.2.1
Quality characteristics, ISO/IEC 25010:2023
Test techniques, CTFL v4.0.1 §4.2-§4.4
Per cent by API, UI and by hand; 100 in all
object
Why these levels, characteristics and techniques
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
A product risk: its likelihood and impact (the level is their product, 1-9) and the cases and requirements it links to.
object
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
Live cases of the project that cover it (checked)
Requirements of the project it is about (checked); their cases are in the matrix
When the testing can start
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
When it is done
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
Markdown
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
«припущення, підтвердіть»: the agent assumed it and asks a person to confirm
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
By the index of content.risks: likelihood x impact on 1-3 each, and the priority it gives (6 and up high, 3-4 medium, below low)
object
Always empty: a part of the project’s plan cannot wait on a question, which belongs to a mission. Kept so the plan reads as a mission’s strategy does
object
Example
{ "projectId": "u-shop::default", "version": 2, "savedBy": "6f1c2b3a-0000-4000-8000-0000000000a2", "savedAt": "2026-11-14T10:00:00.000Z", "restoredFrom": null, "reviewItemId": null, "proposedBy": null, "editedBy": null, "content": { "objectives": [ { "text": "A customer can find, buy and return a product without help", "source": { "kind": "doc-section", "ref": "docs/product.md#goals" } } ], "scope": { "in": [ { "text": "The shop: search, the cart, checkout, returns and the account", "source": { "kind": "doc-section", "ref": "docs/product.md#scope" } } ], "out": [ { "text": "The warehouse back office: another team owns it and tests it", "source": { "kind": "doc-section", "ref": "docs/product.md#out-of-scope" } } ] }, "approach": [ { "text": "Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed", "assumption": true } ], "profile": { "levels": [ "component-integration", "system", "acceptance" ], "characteristics": [ "functional-suitability", "security", "performance-efficiency" ], "techniques": [ "equivalence-partitioning", "boundary-value", "exploratory" ], "split": { "api": 50, "ui": 30, "manual": 20 }, "notes": [ { "text": "The services have their own unit tests in their repositories; this plan starts at their integration", "source": { "kind": "url", "ref": "https://shop.example.com/docs/testing" } } ] }, "risks": [ { "text": "A card is charged twice when the payment page is reloaded", "likelihood": "medium", "impact": "high", "source": { "kind": "endpoint", "ref": "POST /payments" } } ], "entryCriteria": [ { "text": "A release candidate is on staging with its release notes", "assumption": true } ], "exitCriteria": [ { "text": "No open bug of high priority; every high risk has a passing case", "source": { "kind": "doc-section", "ref": "docs/product.md#release" } } ] }, "riskLevels": [ { "level": 6, "priority": "high" } ], "waiting": []}Invalid JSON or body, or code: strategy_lint - the findings of the checks, as for a mission’s strategy
object
object
Where: approach[0], scope.out[1], risks[2].caseIds[0]
Example
{ "error": "the test plan 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, the token is read-only, or the call is an agent’s (a bearer call with X-Plune-Session: code: agent_proposes)
object
Example generated
{ "error": "example"}No such project, or you are not in it
object
Example generated
{ "error": "example"}The plan was saved since baseVersion (code: test_plan_stale, with current), or another save took the same version at the same moment (code: test_plan_race); nothing is saved
object
Example
{ "error": "the test plan was saved since: version 2 is the current one - read it and save on top of it", "code": "test_plan_stale", "current": 2}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.
object
Example generated
{ "error": "example"}Headers
Section titled “Headers ”Seconds until the window rolls over