The tree as one Markdown document

GET

/v1/test-cases/markdown

curl --request GET \
  --url 'https://beta-api.plune.ai/v1/test-cases/markdown?state=draft' \
  --header 'Authorization: Bearer <token>'

• beta
• production
• local

Every case the caller owns, as text/markdown (D9): cases in no suite first, then each suite in tree order with its cases by position. The bin is not in it. suiteId keeps one node’s subtree (and drops the unfiled cases — they are nobody’s subtree); state, repeatable, keeps cases of those states. Read the document with POST /v1/test-cases/markdown after editing it anywhere; plune pull writes it to a file.

Format. Testomat’s Classical Tests Markdown Format, verbatim, plus Plune’s columns: <!-- suite --> / <!-- test --> blocks with key: value metadata, the title as the first #/## heading after the block (its @tags are the tags), ## Steps with *Expected*: under each step, <!-- example --> tables. Cases before the first suite block are in no suite; a nested suite is its path in the title, # apps > web > checkout.spec.ts. Plune’s columns: id is the record’s UUID, type may be eval, state is written for the eye and only read back as a warning, spec carries an automated case’s specRef; ## Preconditions, ## Expected result, ## Prompt and ## Assertions (a JSON array) are the body. The full reference: https://docs.plune.ai/platform/cases/markdown/.

Authorizations

• bearerAuth
• cookieAuth

Parameters

Query Parameters

suiteId

string format: uuid

A folder or suite — the document is its subtree.

state

string

Allowed values: draft in_review active detached deprecated

Repeat for more than one.

Responses

200

The document. X-Plune-Cases counts the cases in it; Content-Disposition names it cases.md.

Media type text/markdown

string

Headers

X-Plune-Cases

integer

Content-Disposition

string

Example

inline; filename="cases.md"

401

No / invalid token or session

404

No such node in the caller’s project

Media type application/json

object

error

required

string

Example ^generated

{
  "error": "example"
}