Have a token? Manage tokens in the console
GET
A document's text at its current version, or at version, with its front matter, findings, mentions and backlinks.
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_id*stringThe space's id, lab_ and a ULID, from List spaces.
document_id*stringThe document's id, ldoc_ and a ULID, from List documents.
version?integerA version number; 0 for the current one.
Format
int32iohr.rfcs.v1.GetDocumentResponse
application/json- response
iohr.rfcs.v1.GetDocumentResponse
author*stringchildren*array<>document?iohr.rfcs.v1.Document
findings*array<>measured_by*array<>measures?iohr.rfcs.v1.Document
mentioned_in*array<>mentions*array<>message*stringparent?iohr.rfcs.v1.Document
saved_at*stringsuccessors*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.getDocument("<space_id>", "<document_id>"); 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.
{ "author": "string", "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" }, "findings": [ { "line": 0, "message": "string", "rule": "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", "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 documents GET
The space's RFCs, studies, PRDs and ADRs, newest change first, each with its number, title, status and the checks' findings on its current version. Filter by `status` and `types` (`rfc`, `study`, `prd`, `adr`); `query` matches number, title and summary. Needs scope `rfc:read`.
Create a document POST
A new RFC, study, PRD (product intent) or ADR (one decision record) from a template, with the next free number of its kind in the account. Sub-RFCs name their parent and get the next part number under it. Needs scope `rfc:write`.