Schemas
Compare two versions of a schema
Have a token? Manage tokens in the console
GET
What changed between two versions, field by field, by JSON Pointer. breaking is a hint that a document the older version accepted may now be refused, not a verdict.
Needs scope schemas:read.
bearerheader
AuthorizationBearer <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.
from?stringThe older major.
Format
int64to?stringThe newer major.
Format
int64iohr.schemas.v1.DiffSchemaVersionsResponse
application/json- response
iohr.schemas.v1.DiffSchemaVersionsResponse
breaking*booleanchanges*array<>from*stringFormat
int64path*stringto*stringFormat
int64SDK
HTTP
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.diffSchemaVersions(); 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.
Example Response
{ "breaking": true, "changes": [ { "after": "string", "before": "string", "breaking": true, "kind": "string", "pointer": "string" } ], "from": "string", "path": "string", "to": "string"}