Skip to main content
REST client

Well-known documents

The 2 operations under .well-known, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Well-known documents

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 /.well-known/oauth-authorization-server

GET/.well-known/oauth-authorization-server

Authorization-server metadata (RFC 8414)

const result = await cs.api.get("/.well-known/oauth-authorization-server");

Parameters, body and every documented response: GET /.well-known/oauth-authorization-server in the HTTP reference.

GET /.well-known/oauth-protected-resource

GET/.well-known/oauth-protected-resource

Protected-resource metadata (RFC 9728)

const result = await cs.api.get("/.well-known/oauth-protected-resource");

Parameters, body and every documented response: GET /.well-known/oauth-protected-resource in the HTTP reference.

Well-known documents | CodeSpar