Skip to main content
REST client

Spec

The 2 operations under openapi.json, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Spec

Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.

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

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

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.

Spec | CodeSpar