Skip to main content

Overview

Connector plays an important role in the platform, providing the functionality for a specific technology. For more information, see Connector Architecture.

Connector NG

Connector NG (New Generation) is the next evolution of the Connector architecture. Instead of Function Groups and Kinds, Connector NG uses versioned interfaces with optional feature flags to describe capabilities.

Key improvements in Connector NG:

  • Interface versioning — each interface can have an independent version, allowing gradual evolution
  • Feature flags — indicate optional capabilities beyond the API reference (e.g., Stateless, Async Issue, CBOM output)
  • Consistent error handling — standardized application/problem+json responses conforming to RFC 9457
  • Kubernetes-native health probes — dedicated liveness and readiness endpoints
  • Observability — built-in metrics endpoint exposing Prometheus/OpenMetrics data

The following interfaces are mandatory for each Connector NG:

NameEndpointShort description
Info v2GET /v2/infoConnector identity, version, and list of implemented interfaces with versions and features
Health v2GET /v2/healthHealth status with Kubernetes liveness and readiness probes
AttributesGET /.../{operation}/attributesPer-operation attribute definitions without a separate validation endpoint
MetricsGET /v1/metricsPrometheus/OpenMetrics metrics for observability

Error handling across all Connector NG interfaces follows the Error Handling specification.

Legacy Connectors

Legacy connectors use Function Groups and Kinds to describe their capabilities. The following interfaces are mandatory for each legacy Connector:

NameShort description
InfoInformation about the Connector, its Function Groups, supported Kinds, list of endpoints
HealthStatus information about the Connector and its services
AttributesAttributes definition of the Connector specific technology and its validation