Operator decisions that override the derived connectivity graph.

GET

/api/v1/topology/link-overrides

curl --request GET \
  --url https://example.com/api/v1/topology/link-overrides \
  --header 'Authorization: Bearer <token>'

A group-scoped caller sees only decisions whose both endpoints are visible to them, matching how the links themselves are filtered.

Authorizations

• bearer

Responses

200

Every visible link override

Media typeapplication/json

Every operator decision visible to the caller.

object

overrides

required

Array<object>

One operator decision about one link.

object

a_node

required

The lower-ordered endpoint. Endpoints are stored in a canonical order, so this is not necessarily the one that was submitted first.

string format: uuid

action

required

What an operator has decided about a link, overriding whatever the derivation produces.

string

Allowed values: pin hide direction

b_node

required

The higher-ordered endpoint.

string format: uuid

created_at

required

When it was recorded (RFC 3339).

string

created_by

Who recorded the decision.

string | null

direction

One of:

null

null

string

Which endpoint is upstream. Present only when action is direction.

string

Allowed values: a_parent b_parent

id

required

string format: uuid

note

string | null

Example

{
  "overrides": [
    {
      "action": "pin",
      "direction": "a_parent"
    }
  ]
}

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks the view permission

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Skeleton mode has no write side

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}