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

Mark a document open, decided or superseded. Decided needs the space's approvals on the current version; superseded names the document that replaces 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.

document_id*string

The document's id, ldoc_ and a ULID, from List documents.

Request Body

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

application/json
  1. body

iohr.rfcs.v1.SetStatusRequest

base_version?integer
Formatint32
document_id?string
space_id?string
status?string
successor_id?string

Response Body

iohr.rfcs.v1.SetStatusResponse

application/json
  1. response

iohr.rfcs.v1.SetStatusResponse

document?

iohr.rfcs.v1.Document

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.setStatus("<space_id>", "<document_id>", { status: "<status>" });  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"  }}

List versions GET

Every version of a document, newest first: who saved it, when, the message and the lines added and removed. Needs scope `rfc:read`.

Set who reads a document POST

One of `public`, `preview`, `partner`, `team` or `internal`; the space's owners and admins only. Public needs the redaction check to find nothing in the current version, else 412 names each finding's rule and line. Preview and partner are for InOrbit's own spaces. Needs scope `rfc:write`.