Spec

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /openapi.json

This document

const result = await cs.api.get("/openapi.json");

Parameters, body and every documented response: GET /openapi.json in the HTTP reference.

GET /v1/openapi.json

This document, under the /v1 mount

const result = await cs.api.get("/v1/openapi.json");

Parameters, body and every documented response: GET /v1/openapi.json in the HTTP reference.