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

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.

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.

Request Body

iohr.rfcs.v1.CreateDocumentRequest; path variables override their fields

application/json
  1. body

iohr.rfcs.v1.CreateDocumentRequest

child_index?integer
Formatint32
kind?string
number?integer
Formatint32
parent_id?string
space_id?string
summary?string
template?string
title?string

Response Body

iohr.rfcs.v1.CreateDocumentResponse

application/json
  1. response

iohr.rfcs.v1.CreateDocumentResponse

document?

iohr.rfcs.v1.Document

findings*array<>
text*string
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.createDocument("<space_id>", {    kind: "<kind>",    summary: "<summary>",    template: "<template>",    title: "<title>",  });  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.

{  "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"    }  ],  "text": "string"}

Get a document GET

A document's text at its current version, or at `version`, with its front matter, findings, mentions and backlinks. Needs scope `rfc:read`.

Save a version POST

Save new text as the next version with a message. Send the version you started from: if someone saved after it, the answer is 409 and nothing is overwritten. The checks run on every save and their findings come back. Needs scope `rfc:write`.