Skip to content

Sensorium Interface Actuation Descriptor v1

Source schema: doc/schemas/sensorium-interface-actuation-descriptor.v1.schema.json

Immutable publication contract for one effect-bearing Sensorium Interface.

Fields

Field Required Shape Description
schema yes const: sensorium-interface-actuation-descriptor.v1
schema/v yes const: 1
interface/id yes ref: #/$defs/interface_ref
interface/kind yes const: actuation
interface/name yes string
publisher/node-ref yes string
methods yes array
receipt/schema-ref yes ref: #/$defs/ref
coordination/mode yes enum: shared, exclusive-lease
classification/max-tier yes enum: Public, Community, Personal
classification/topic-class yes string
redaction/profile-ref no ref: #/$defs/ref
source/generation-ref yes ref: #/$defs/ref
operational/context yes ref: sensorium-operational-context.v1.schema.json
supersedes/interface-id no ref: #/$defs/interface_ref
limits yes ref: #/$defs/limits
published/at yes string
expires/at yes string

Definitions

Definition Shape Description
ref string
interface_ref string
limits object

Conditional Rules

Rule 1

When:

{
  "properties": {
    "coordination/mode": {
      "const": "exclusive-lease"
    }
  },
  "required": [
    "coordination/mode"
  ]
}

Then:

{
  "properties": {
    "limits": {
      "required": [
        "claim/queue-max",
        "claim/wait-max-ms",
        "lease/quantum-max-ms",
        "lease/cumulative-max-ms"
      ]
    }
  }
}

Field Semantics

schema

  • Required: yes
  • Shape: const: sensorium-interface-actuation-descriptor.v1

schema/v

  • Required: yes
  • Shape: const: 1

interface/id

  • Required: yes
  • Shape: ref: #/$defs/interface_ref

interface/kind

  • Required: yes
  • Shape: const: actuation

interface/name

  • Required: yes
  • Shape: string

publisher/node-ref

  • Required: yes
  • Shape: string

methods

  • Required: yes
  • Shape: array

receipt/schema-ref

  • Required: yes
  • Shape: ref: #/$defs/ref

coordination/mode

  • Required: yes
  • Shape: enum: shared, exclusive-lease

classification/max-tier

  • Required: yes
  • Shape: enum: Public, Community, Personal

classification/topic-class

  • Required: yes
  • Shape: string

redaction/profile-ref

  • Required: no
  • Shape: ref: #/$defs/ref

source/generation-ref

  • Required: yes
  • Shape: ref: #/$defs/ref

operational/context

  • Required: yes
  • Shape: ref: sensorium-operational-context.v1.schema.json

supersedes/interface-id

  • Required: no
  • Shape: ref: #/$defs/interface_ref

limits

  • Required: yes
  • Shape: ref: #/$defs/limits

published/at

  • Required: yes
  • Shape: string

expires/at

  • Required: yes
  • Shape: string

Definition Semantics

$defs.ref

  • Shape: string

$defs.interface_ref

  • Shape: string

$defs.limits

  • Shape: object