Docs
Have a token? Manage tokens in the console
GET
/v1/rfcs/spaces/{space_id}/documents

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.

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.

Path Parameters

space_id*string

The space's id, lab_ and a ULID, from List spaces.

Query Parameters

status?string

open, decided or superseded; empty for all.

types?string

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

query?string

Words in the number, title or summary.

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.

mine?boolean

Response Body

iohr.rfcs.v1.ListDocumentsResponse

application/json
  1. response

iohr.rfcs.v1.ListDocumentsResponse

documents*array<>
next_page_token*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const document of api.rfcs.allListDocuments("<space_id>")) {    console.log(document);  }} 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"}