Skip to content

The project’s test plan as a file

GET
/v1/projects/{id}/test-plan/export
curl --request GET \
--url 'https://beta-api.plune.ai/v1/projects/example/test-plan/export?format=md' \
--header 'Authorization: Bearer <token>'

The current version as Markdown (format=md, the default) or PDF (format=pdf), named <project>-test-plan-v<version>.md or .pdf - the sections of the plan, each item with what it rests on; the export of a mission’s strategy, under the plan’s title. A snapshot; the main copy stays in Plune. Anyone in the project, a reader too. Sent with Content-Disposition: attachment, Cache-Control: no-store and X-Content-Type-Options: nosniff. Twelve a minute.

id
required
string

The project’s id

format
string
default: md
Allowed values: md pdf

Markdown or PDF

The file

string
Example
# Test plan: Shop
Version 2, saved 2026-11-14.
Exported from Plune. A snapshot: the main copy stays in Plune, where it is changed - a new export replaces this file.
## Objectives
- A customer can find, buy and return a product without help (doc-section: docs/product.md#goals)
## Scope
### In scope
- The shop: search, the cart, checkout, returns and the account (doc-section: docs/product.md#scope)
### Not tested
- The warehouse back office: another team owns it and tests it (doc-section: docs/product.md#out-of-scope)
## Approach
- Each release: the API first, from the OpenAPI file; then the UI flows of the shop; exploratory sessions on what changed (assumption, to confirm)
## Methodology profile
- Test levels: component-integration, system, acceptance
- Quality characteristics (ISO/IEC 25010:2023): functional-suitability, security, performance-efficiency
- Techniques: equivalence-partitioning, boundary-value, exploratory
- Split: API 50%, UI 30%, manual 20%
- The services have their own unit tests in their repositories; this plan starts at their integration (url: https://shop.example.com/docs/testing)
## Risks
- **high** (level 6: likelihood medium, impact high) A card is charged twice when the payment page is reloaded (endpoint: POST /payments)
## Entry criteria
- A release candidate is on staging with its release notes (assumption, to confirm)
## Exit criteria
- No open bug of high priority; every high risk has a passing case (doc-section: docs/product.md#release)
Content-Disposition
string
Example
attachment; filename="Shop-test-plan-v2.md"; filename*=UTF-8''Shop-test-plan-v2.md
Content-Length
integer

A format that is not md or pdf

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

No / invalid token or session

No such project, or you are not in it; or the project has no test plan yet (code: test_plan_none)

Media type application/json
object
error
required
string
Example
{
"error": "the project has no test plan yet",
"code": "test_plan_none"
}

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