The test documentation as one file
const url = 'https://beta-api.plune.ai/v1/projects/example/test-docs/export?format=md';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The project’s id
Query Parameters
Section titled “Query Parameters ”Markdown or PDF
Responses
Section titled “ Responses ”The file
Headers
Section titled “Headers ”A format that is not md or pdf
object
Example generated
{ "error": "example"}No / invalid token or session
No such project, or you are not in it
object
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.
object
Example generated
{ "error": "example"}Headers
Section titled “Headers ”Seconds until the window rolls over