Skip to main content

service_wire

Typed specification

Generated by the pinned ess generate --kind docs from ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

Public service envelope, observation and operation metadata values; the first v1alpha2 binding is served and read, no persisted entity.

connectors.service_wire is one of connectors's bounded contexts. Back to the index.

Types​

AdapterOperationCuration​

connectors.service_wire.AdapterOperationCuration is a record of four fields:

  • adapter_alias — String
  • executable_selection — String
  • bootstrap_sha256 — String
  • operations — List<connectors.service_wire.CuratedOperation>

AttemptReference​

connectors.service_wire.AttemptReference is a record of two fields:

  • instance — String
  • id — connectors.mutations.AttemptId

AuditStatus​

connectors.service_wire.AuditStatus is one of complete, incomplete, unavailable and not_required.

AuthAlternative​

connectors.service_wire.AuthAlternative is a record of two fields:

  • profile — String
  • scopes — List<String>

BaseErrorCode​

connectors.service_wire.BaseErrorCode is one of invalid_input, unsupported, unauthorized, forbidden, not_found, stale_description, stale_cursor, rate_limited, unavailable, capacity, timeout, upstream_protocol and internal.

CauseStage​

connectors.service_wire.CauseStage is one of preflight, attempt_store, approval, dispatch, response, observation and audit.

CuratedOperation​

connectors.service_wire.CuratedOperation is a record of two fields:

  • operation — String
  • metadata — connectors.service_wire.OperationMetadata

DiagnosticCause​

connectors.service_wire.DiagnosticCause is a record of two fields:

  • code — connectors.service_wire.BaseErrorCode
  • stage — connectors.service_wire.CauseStage

Error​

connectors.service_wire.Error is a record of three fields:

  • code — connectors.service_wire.ErrorCode
  • message — String
  • retry_after_seconds — Optional<Integer>, which may be absent

ErrorCode​

connectors.service_wire.ErrorCode is one of invalid_input, unsupported, unauthorized, forbidden, not_found, stale_description, stale_cursor, rate_limited, unavailable, capacity, timeout, upstream_protocol, internal, approval_required, approval_refused, approval_replayed, idempotency_conflict, outcome_unknown, not_granted, stale_authority, connection_not_ready, route_unavailable, route_refused, insufficient_scope, session_not_ready, session_lost, offer_expired, offer_rejected, lease_expired, revoked and conflict.

IdempotencyKeySource​

connectors.service_wire.IdempotencyKeySource is one of caller_supplied.

InvokeRequest​

connectors.service_wire.InvokeRequest is a record of five fields:

  • version — String
  • request_id — String
  • operation — String
  • revision — String
  • input — Json

InvokeResponse​

connectors.service_wire.InvokeResponse is a record of nine fields:

  • version — connectors.service_wire.Version
  • request_id — Optional<String>, which may be absent
  • status — connectors.service_wire.ResponseStatus
  • result — Optional<Json>, which may be absent
  • error — Optional<connectors.service_wire.Error>, which may be absent
  • audit_ref — Optional<String>, which may be absent
  • audit_status — connectors.service_wire.AuditStatus
  • source_audit — Optional<connectors.service_wire.SourceAudit>, which may be absent
  • mutation — Optional<connectors.service_wire.MutationObservation>, which may be absent

Every value satisfies version == v1alpha2, ((status == success and defined(result) and not (defined(error))) or (status == error and defined(error) and not (defined(result)))), ((audit_status == complete and defined(audit_ref)) or (audit_status == incomplete and defined(audit_ref)) or (audit_status == unavailable and not (defined(audit_ref))) or (audit_status == not_required and not (defined(audit_ref)))) and (status != success or not (defined(mutation)) or mutation.classification == applied).

KeyedInvokeRequest​

connectors.service_wire.KeyedInvokeRequest is a record of six fields:

  • version — String
  • request_id — String
  • operation — String
  • revision — String
  • input — Json
  • idempotency_key — Optional<String>, which may be absent

MutationObservation​

connectors.service_wire.MutationObservation is a record of five fields:

  • classification — connectors.mutations.EffectKnowledge
  • attempt — Optional<connectors.service_wire.AttemptReference>, which may be absent
  • original_request_id — Optional<String>, which may be absent
  • replayed — Boolean
  • cause — Optional<connectors.service_wire.DiagnosticCause>, which may be absent

OperationCuration​

connectors.service_wire.OperationCuration is a record of two fields:

  • format — String
  • adapters — List<connectors.service_wire.AdapterOperationCuration>

OperationIdempotency​

connectors.service_wire.OperationIdempotency is a record of three fields:

  • kind — connectors.mutations.IdempotencyKind
  • key — Optional<connectors.service_wire.IdempotencyKeySource>, which may be absent
  • retention_seconds — Optional<Integer>, which may be absent

OperationLimits​

connectors.service_wire.OperationLimits is a record of five fields:

  • request_bytes — Integer
  • result_bytes — Integer
  • execution_ms — Integer
  • provider_ms — Integer
  • connect_ms — Integer

OperationMetadata​

connectors.service_wire.OperationMetadata is a record of eight fields:

  • effects — List<connectors.mutations.ExecutableEffect>
  • semantic_effects — List<connectors.mutations.SemanticEffect>
  • risk — connectors.artifact_provenance.Risk
  • idempotency — connectors.service_wire.OperationIdempotency
  • approval — connectors.mutations.ApprovalMode
  • requires_auth — Optional<List<connectors.service_wire.AuthAlternative>>, which may be absent
  • realization — Optional<connectors.artifact_provenance.Realization>, which may be absent
  • limits — connectors.service_wire.OperationLimits

ResponseStatus​

connectors.service_wire.ResponseStatus is one of success and error.

SourceAudit​

connectors.service_wire.SourceAudit is a record of three fields:

  • instance — String
  • audit_ref — Optional<String>, which may be absent
  • audit_status — connectors.service_wire.AuditStatus

Version​

connectors.service_wire.Version is one of v1alpha1 and v1alpha2.

Four of the types above are reached by nothing else in this system: connectors.service_wire.InvokeRequest, connectors.service_wire.InvokeResponse, connectors.service_wire.KeyedInvokeRequest and connectors.service_wire.OperationCuration. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors v1 · model digest e1e1672d0af4753cb8f2da6c0b22a7f6ae8ce9f7abc168f86169babdf1325787 · contract digest slice-sha256/2:8e0ee3a243a52d9c87fe64333e7714fcb5ba8d853967bbc8261eb9a72800eb6d. Do not edit this file; change the specification and regenerate it with ess generate.