InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/rfcs/public/documents

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.

Authorization

bearer
headerAuthorizationBearer <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.

Query Parameters

space?string

A space's id, or the slug of one of InOrbit's spaces; empty for all of InOrbit's.

types?string

rfc, study, prd or adr; empty for every kind.

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

Response Body

iohr.rfcs.v1.ListPublicDocumentsResponse

application/json
  1. response

iohr.rfcs.v1.ListPublicDocumentsResponse

documents*array<>
next_page_token*string
spaces*array<>
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.listPublicDocuments();  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.

{  "documents": [    {      "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"    }  ],  "next_page_token": "string",  "spaces": [    {      "name": "string",      "slug": "string",      "space_id": "string"    }  ]}

Export a space GET

Every document as Markdown in the RFC format and every diagram as JSON, a page at a time; follow `next_page_token` to the end. Needs scope `rfc:read`.

Get a public document 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`.