The endpoints the mission’s strategy names, as an OpenAPI draft
const url = 'https://beta-api.plune.ai/v1/missions/example/export/openapi';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/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.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The mission’s id
Responses
Section titled “ Responses ”The document; Content-Disposition names the file
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 } } }}Headers
Section titled “Headers ”Example
attachment; filename="Shop-checkout-endpoints.openapi.json"; filename*=UTF-8''Shop-checkout-endpoints.openapi.jsonNo / invalid token or session
No such mission in your project
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