Skip to content

The endpoints the mission’s strategy names, as an OpenAPI draft

GET
/v1/missions/{id}/export/openapi
curl --request GET \
--url https://beta-api.plune.ai/v1/missions/example/export/openapi \
--header 'Authorization: Bearer <token>'

An OpenAPI 3.0.3 document (#2194) of the operations the accepted strategy names in its endpoint sources (POST /cart; a ref in other words, or a path with an id in it, names none): each one the project’s API catalog has, as GET /v1/api-endpoints/export describes it, and each one it has not with x-plune-source: strategy and x-cairn-derived. A mission with no accepted strategy, or one naming no endpoint, is a document with no paths. Named <mission>-endpoints.openapi.json. The whole catalog of the project is GET /v1/api-endpoints/export. On every tier, Free too, and to anyone in the project, a reader too. Twelve a minute.

id
required
string

The mission’s id

The document; Content-Disposition names the file

Media type application/json
object
Example
{
"openapi": "3.0.3",
"info": {
"title": "Shop checkout: endpoints",
"version": "0.0.0",
"description": "The endpoints the mission’s accepted strategy names, as the project’s API catalog describes them; what is marked x-cairn-derived was inferred, not described by a spec. Exported from Plune. A snapshot: the main copy stays in Plune, where it is changed - a new export replaces this file."
},
"paths": {
"/cart": {
"post": {
"summary": "Add to the cart",
"responses": {
"default": {
"description": "Not described in the catalog"
}
},
"x-plune-source": "spec"
}
},
"/payments": {
"post": {
"responses": {
"default": {
"description": "Named by the mission’s strategy; not in the project’s API catalog"
}
},
"x-plune-source": "strategy",
"x-cairn-derived": true
}
}
}
}
Content-Disposition
string
Example
attachment; filename="Shop-checkout-endpoints.openapi.json"; filename*=UTF-8''Shop-checkout-endpoints.openapi.json

No / invalid token or session

No such mission in your project

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