Skip to content

Sensorium Interface Invoke Request v1

Source schema: doc/schemas/sensorium-interface-invoke-request.v1.schema.json

Fields

Field Required Shape Description
schema yes const: sensorium-interface-invoke-request.v1
schema/v yes const: 1
operation/id yes string
idempotency/key yes string
interface/id yes string
caller/ref yes ref: #/$defs/ref
grant/id yes ref: #/$defs/ref
source/generation-ref yes ref: #/$defs/ref
operational/context yes ref: sensorium-operational-context.v1.schema.json
coordination/mode yes enum: shared, exclusive-lease
lease/id no string
lease/epoch no integer
caller/sequence no integer
method/name yes string
input/schema-ref yes ref: #/$defs/ref
payload yes unspecified
deadline/at yes string
classification yes ref: classification.v1.schema.json
causal/context yes ref: causal-context.v1.schema.json

Definitions

Definition Shape Description
ref string

Conditional Rules

Rule 1

When:

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

Then:

{
  "required": [
    "lease/id",
    "lease/epoch",
    "caller/sequence"
  ]
}

Field Semantics

schema

  • Required: yes
  • Shape: const: sensorium-interface-invoke-request.v1

schema/v

  • Required: yes
  • Shape: const: 1

operation/id

  • Required: yes
  • Shape: string

idempotency/key

  • Required: yes
  • Shape: string

interface/id

  • Required: yes
  • Shape: string

caller/ref

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

grant/id

  • Required: yes
  • 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

coordination/mode

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

lease/id

  • Required: no
  • Shape: string

lease/epoch

  • Required: no
  • Shape: integer

caller/sequence

  • Required: no
  • Shape: integer

method/name

  • Required: yes
  • Shape: string

input/schema-ref

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

payload

  • Required: yes
  • Shape: unspecified

deadline/at

  • Required: yes
  • Shape: string

classification

  • Required: yes
  • Shape: ref: classification.v1.schema.json

causal/context

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

Definition Semantics

$defs.ref

  • Shape: string