external-system¶
System outside the modeled Domain that the Domain talks to. See Concepts: External System.
Fields¶
| Field | Required | Description |
|---|---|---|
apiVersion |
yes | schema.esdm.io/core/v1 |
kind |
yes | external-system |
name |
yes | The External System name. |
scope |
yes | scope.domain reference. |
direction |
yes | inbound, outbound, or bidirectional. |
category |
no | Free-form short tag for the kind of External System (payment, mail, identity, geocoding, ...). Not an enum: new categories appear all the time. |
capabilities |
no | List of free-form descriptive strings naming the operations or interactions the Domain uses ("create a charge", "receive payment-succeeded webhook"). Documentation, not a callable surface. |
description |
no | Free-form prose. |
metadata |
no | Non-semantic labels and annotations. |
The direction determines which connections the External System can participate in. An inbound system can be the source of an Event that lands in the Domain; an outbound system is what an Event Handler ultimately calls; a bidirectional system does both.