Schemas
Get a schema
One version of a schema, the newest when none is named: the document as stored, with its examples and the invalid cases it refuses.
Needs scope schemas:read.
bearerAuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
path?stringThe schema's path, <area>/<name>, as List schemas gives it.
version?stringThe version's major number, from List a schema's versions.
int64iohr.schemas.v1.GetSchemaResponse
application/json- response
iohr.schemas.v1.GetSchemaResponse
document*stringexamples*array<>invalid*array<>schema?iohr.schemas.v1.SchemaFamily
version?iohr.schemas.v1.SchemaVersion
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.schemas.getSchema(); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "document": "string", "examples": [ { "content": "string", "name": "string" } ], "invalid": [ { "content": "string", "name": "string" } ], "schema": { "area": "string", "majors": [ "string" ], "name": "string", "note": "string", "owner": "string", "path": "string", "replaced_by": "string", "status": "string", "visibility": "string" }, "version": { "id": "string", "major": "string", "size_bytes": "string", "status": "string" }}