Skip to content

The test documentation as one file

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

The pack of the section «Test documentation» (#2747, ADR 0082 §5, Е1; implementation decision D6: its parts are fixed, the call picks only the format): the current test plan, the coverage (the latest matrix version and the API catalog’s summary), the requirements with their acceptance criteria, and the cases with where they come from - as Markdown (format=md, the default) or PDF from the same text, named <project>-test-documentation-<date>.md or .pdf. An empty part says so. At most 200 requirements and 200 cases are listed, the rest is a number. Anyone in the project, a reader too, on every plan. Twelve a minute.

id
required
string

The project’s id

format
string
default: md
Allowed values: md pdf

Markdown or PDF

The file

string
Content-Disposition
string
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

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