Integrations pillar · v0.8.1

integration Integration

Integration data contract aligned with ODPS input ports and ODCS contract concepts.

$id · https://corpospec.com/schemas/v0.8.1/integration.schema.json

Fields

Field Type Required Description
id PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
name string yes
status IntegrationStatus yes Integration lifecycle status.
system string yes
type IntegrationType yes Integration direction type.
config any Connector-specific opaque configuration. The shape is deliberately free-form: each integration defines its own keys (e.g. `profile_ids`, `owner`/`repo`, `project_slug`) because connectors target different systems with incompatible parameter models. Consumers must know the connector to interpret this map.
data_contract DataContract?
input_port InputPort?
outputs PathRef[]
pipeline Pipeline?

Definitions

Shared types referenced within this schema.

Aggregation
Aggregation method for pipeline field mappings.
enum: "sum", "avg", "count", "first", "last", "max", "min", "median", "p50", "p95", "p99", "percentile", "ratio", "stddev", "variance"
AuthMethod
Authentication method.
enum: "api_key", "oauth2", "basic", "mtls", "ssh", "none"
DataContract
Data contract.
type: object
DataField
Data contract field definition.
type: object
DataQuality
Data quality constraints declared by the contract owner.
type: object
DataSchema
Data contract schema.
type: object
FieldMapping
Maps a source field to a CorpoSpec metric via aggregation.
type: object
Freshness
Freshness requirements.
type: object
InputPort
Input port configuration.
type: object
IntegrationStatus
Integration lifecycle status.
enum: "draft", "development", "testing", "active", "sunset", "retired"
IntegrationType
Integration direction type.
enum: "source", "destination", "bidirectional"
PathRef
Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
Pipeline
Pipeline configuration: how raw records are transformed into metric snapshots.
type: object
Sla
Service level agreement offered by the source system for this contract.
type: object

Reference in your YAML

# yaml-language-server: $schema=https://corpospec.com/schemas/v0.8.1/integration.schema.json