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

Where the work stands: proposed, building, in_review, partly_live, live or abandoned. The reason is appended to the status log in the same new version. partly_live and live need merged pull requests recorded on the document, and are refused until those are.

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.SetStageRequest; path variables override their fields

application/json
  1. body

iohr.rfcs.v1.SetStageRequest

base_version?integer
Formatint32
document_id?string
reason?string
space_id?string
stage?string

Response Body

iohr.rfcs.v1.SetStageResponse

application/json
  1. response

iohr.rfcs.v1.SetStageResponse

document?

iohr.rfcs.v1.Document

version*integer
Formatint32
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.setStage("<space_id>", "<document_id>", {    reason: "<reason>",    stage: "<stage>",  });  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"  },  "version": 0}

Append a status-log line POST

Add one dated line at the end of a document's `## Status log` without sending its text: a new version on top of the current one, so a save in between is kept. Without `base_version` it never conflicts. One line of 1 to 2000 characters; the date `YYYY-MM-DD`, today (UTC) when empty. On a public document the line must pass the redaction check, else 412 names the rule and line. Needs scope `rfc:write`.

Set where a document is kept POST

`product` (edited here; an import from a repository leaves it alone) or `repository` (a file is the source and the import updates it). The space's owners and admins move a document to the product; back to the repository is for InOrbit's admins. Needs scope `rfc:write`.