Have a token? Manage tokens in the console
GET
One document by its space, kind and number, with no token when it is public. Anything you may not read is 404.
Needs scope rfc:read.
bearerheader
AuthorizationBearer <token>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.
space*stringA space's id, or the slug of one of InOrbit's spaces.
kind*stringrfc or study.
number*string0065, 65, or 0040.1 for a part.
version?integerA version number; 0 for the current one.
Format
int32iohr.rfcs.v1.GetPublicDocumentResponse
application/json- response
iohr.rfcs.v1.GetPublicDocumentResponse
children*array<>document?iohr.rfcs.v1.Document
measured_by*array<>measures?iohr.rfcs.v1.Document
mentioned_in*array<>mentions*array<>message*stringparent?iohr.rfcs.v1.Document
saved_at*stringspace?iohr.rfcs.v1.SpaceRef
successors*array<>supersedes?iohr.rfcs.v1.Document
text*stringversion*integerFormat
int32SDK
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.rfcs.getPublicDocument("<space>", "<kind>", "<number>"); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}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.
{ "children": [ { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" } ], "document": { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" }, "measured_by": [ { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" } ], "measures": { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" }, "mentioned_in": [ { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" } ], "mentions": [ { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" } ], "message": "string", "parent": { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" }, "saved_at": "string", "space": { "name": "string", "slug": "string", "space_id": "string" }, "successors": [ { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" } ], "supersedes": { "access": "string", "child_index": 0, "children": 0, "created_at": "string", "created_by": "string", "current_version": 0, "display_number": "string", "document_id": "string", "headline": "string", "headline_note": "string", "kind": "string", "measures_id": "string", "number": 0, "parent_id": "string", "path": "string", "public": true, "slug": "string", "source": "string", "space_id": "string", "stage": "string", "status": "string", "summary": "string", "superseded_by": "string", "supersedes_id": "string", "title": "string", "updated_at": "string" }, "text": "string", "version": 0}List public documents GET
Documents you may read without belonging to their space: with no token, the public ones; signed in, also what your role allows. Last changed first. Needs scope `rfc:read`.
Get a public diagram GET
A diagram that a document you may read embeds, with no token when that document is public. Needs scope `rfc:read`.