Przejdź do treści

Component Communication Report V1

Source schema: doc/schemas/component-communication-report.v1.schema.json

Bounded component claim submitted through authenticated middleware.trace.report.

Governing Basis

Project Lineage

Fields

Field Required Shape Description
schema yes const: component-communication-report.v1
schema/v yes const: 1
report/id yes ref: #/$defs/ref
report/sequence no integer
boundary/id yes ref: #/$defs/ref
source yes ref: #/$defs/endpoint
target yes ref: #/$defs/endpoint
stage yes enum: egress-admitted, egress-failed, ingress-admitted, ingress-refused, completed, timed-out, canceled
operation yes string
message/ref no ref: #/$defs/ref
causal/context-ref no ref: #/$defs/ref
causal/context-digest no ref: #/$defs/digest
correlation/id no ref: #/$defs/ref
occurred/at yes string
payload yes ref: #/$defs/payload
reason/code no string
retryable no boolean

Definitions

Definition Shape Description
ref string
digest string
endpoint object
payload object

Conditional Rules

Rule 1

When:

{
  "required": [
    "causal/context-ref"
  ]
}

Then:

{
  "required": [
    "causal/context-digest"
  ]
}

Rule 2

When:

{
  "required": [
    "reason/code"
  ]
}

Then:

{
  "required": [
    "retryable"
  ]
}

Field Semantics

schema

  • Required: yes
  • Shape: const: component-communication-report.v1

schema/v

  • Required: yes
  • Shape: const: 1

report/id

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

report/sequence

  • Required: no
  • Shape: integer

boundary/id

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

source

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

target

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

stage

  • Required: yes
  • Shape: enum: egress-admitted, egress-failed, ingress-admitted, ingress-refused, completed, timed-out, canceled

operation

  • Required: yes
  • Shape: string

message/ref

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

causal/context-ref

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

causal/context-digest

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

correlation/id

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

occurred/at

  • Required: yes
  • Shape: string

payload

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

reason/code

  • Required: no
  • Shape: string

retryable

  • Required: no
  • Shape: boolean

Definition Semantics

$defs.ref

  • Shape: string

$defs.digest

  • Shape: string

$defs.endpoint

  • Shape: object

$defs.payload

  • Shape: object