Schemas
List schemas
The JSON Schemas InOrbit publishes and keeps, sorted by path, a page at a time. Filter by visibility, status, area or a word in the path, owner or note.
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.
visibility?stringOnly this visibility: public, internal or gated.
status?stringOnly this status: draft, stable or deprecated.
area?stringOnly this area, the first path segment.
query?stringOnly schemas whose path, owner or note contains this, any case.
page_size?integerAt most this many; 0 means 50, above 200 means 200.
int32page_token?stringFrom the previous page's next_page_token.
iohr.schemas.v1.ListSchemasResponse
application/json- response
iohr.schemas.v1.ListSchemasResponse
next_page_token*stringschemas*array<>total_size*integerint32import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { for await (const schemaFamily of api.schemas.allListSchemas()) { console.log(schemaFamily); }} 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.
{ "next_page_token": "string", "schemas": [ { "area": "string", "majors": [ "string" ], "name": "string", "note": "string", "owner": "string", "path": "string", "replaced_by": "string", "status": "string", "visibility": "string" } ], "total_size": 0}