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

Diagrams across the account's spaces, newest change first, with the documents that embed each counted; or, with space_id and document_id, the diagrams one document embeds in its order.

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

account_id?string

A team you belong to; empty for your own account.

space_id?string

Narrow to one space, lab_ and a ULID.

document_id?string

With space_id: the diagrams this document embeds, in order.

kind?string

architecture, the one kind the model holds today, or empty.

element_kind?string

Diagrams holding an element of this kind: person, system, service, datastore, queue, external, boundary.

updated_after?string

Changed at or after this time, RFC 3339.

query?string

Words in the name or the labels (element names, technologies, descriptions, link labels and protocols).

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.SearchDiagramsResponse

application/json
  1. response

iohr.rfcs.v1.SearchDiagramsResponse

diagrams*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 diagram of api.rfcs.allSearchDiagrams()) {    console.log(diagram);  }} 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.

{  "diagrams": [    {      "created_at": "string",      "created_by": "string",      "current_version": 0,      "diagram_id": "string",      "element_kinds": [        "string"      ],      "kind": "string",      "name": "string",      "nodes": 0,      "space_id": "string",      "space_name": "string",      "svg_path": "string",      "updated_at": "string",      "used_in_count": 0    }  ],  "next_page_token": "string"}

List your review queue GET

Reviews waiting for you across the account's spaces, or the ones you asked of others with `status=asked`. Needs scope `rfc:read`.

List diagrams GET

The space's architecture diagrams, newest change first. Needs scope `rfc:read`.