Skip to content
Embabel Worlds

List the registered node decorators and their tick, batch and staleness settings

GET
/api/v1/admin/kg/decorate
curl --request GET \
  --url http://localhost:11044/api/v1/admin/kg/decorate \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The registered decorators

Media typeapplication/json

The registered node decorators.

object
decorators
required

Every registered decorator, in registration order.

Array<object>

A registered node decorator and the cadence it runs on.

object
batchSize
required

Most candidates one tick will process.

integer format: int32
name
required

The decorator’s stable kebab-case identifier, used in the /admin/kg/decorate/{name} routes and as the prefix of its stamp property.

string
refreshAfter
required

How stale a node must be before it is a candidate again, or never.

string
stampProperty
required

The property stamped on a node once decorated — how staleness is judged.

string
targetLabels
required

Labels this decorator considers as candidates.

Array<string>
unique items
tickInterval
required

How often the scheduled tick fires, ISO-8601 duration.

string

Example generated

{
  "decorators": [
    {
      "batchSize": 1,
      "name": "example",
      "refreshAfter": "example",
      "stampProperty": "example",
      "targetLabels": [
        "example"
      ],
      "tickInterval": "example"
    }
  ]
}

401

Section titled “401”

No authenticated principal

Media typeapplication/json

A refusal carrying only a human-readable reason.

object
error
required

What went wrong, in the terms the caller can act on.

string

Example generated

{
  "error": "example"
}