Preview a system label recompute

POST

/systems:previewLabels

const url = 'https://example.com/api/v1/systems:previewLabels';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/systems:previewLabels

Lists exactly the rows a recompute would change, and leaves the fleet as it found it. Use it before :recomputeLabels to see the blast radius of a rule edit. Every generated label in the caller’s read and update scope is re-rendered from its current rules and compared with what is stored; a label an operator typed by hand is never a candidate. Bounded by the same two scopes the apply is, so it never lists a row the apply would then refuse to touch. A location preview also lists the components and systems placed at every location whose label would move, because those go stale the moment it does. Gated by system:update, the same permission the apply needs: a preview is half of an edit rather than a report, and an operator who cannot apply has no use for it.

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

changed

required

Every row, one entry each. Bounded by the fleet, not paginated: this is the whole blast radius by design

Array<object> | null

object

from

required

The label as stored now; empty when the entity has none

string

required

The entity’s uuid

string

kind

required

The entity kind this row belongs to: component, system, or location

string

name

required

The entity’s name, for display

string

required

The label its rules produce; empty when the rule renders nothing

string

count

required

How many rows changed, or would change

integer format: int64

Example

{
  "$schema": "/api/v1/schemas/LabelRecomputeOutputBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}