v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB

ConnectorResources

Discover connector resources

Runs connector discovery and returns suggested resource descriptors and operation hints. Discovery results are advisory; callers must create resource descriptors and operation bindings explicitly before routes can use them.

post/connectors/{connectorInstanceId}/discoveryruns

Path parameters

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Stable identifier of the configured connector instance. This is not the Party id; the connector instance has its own id and points at its backing Party.

Request body

includeFieldsboolean

Whether discovery should include field-level descriptors when available.

includeOperationsboolean

Whether discovery should include operation hints such as OpenAPI operation ids or database read/write capabilities.

schemaDriftPolicy'IGNORE' | 'WARN' | 'FAIL'

Action to apply when a live discovered contract hash differs from the persisted resource descriptor contract hash. IGNORE suppresses drift findings, WARN returns findings, and FAIL rejects discovery.

filtersStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example request

{
  "includeFields": true,
  "includeOperations": true,
  "schemaDriftPolicy": "WARN",
  "filters": {
    "path_prefix": "/employees"
  }
}

Response

Discovery result with suggested resource descriptors.

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example response

{
  "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
  "resources": [
    {
      "externalResourceName": "/employees/{employee_id}",
      "resourceKind": "OBJECT",
      "representationKind": "JSON",
      "supportedOperations": [
        "READ",
        "QUERY"
      ],
      "suggestedDescriptor": {
        "resourceDescriptorId": "9f70b114-35a6-4700-a8a3-7ad0c2d81202",
        "displayName": "Workday employee profile response",
        "resourceKind": "OBJECT",
        "representationKind": "JSON",
        "shapeKind": "OPENAPI_SCHEMA",
        "contract": {
          "contractKind": "OPENAPI",
          "uri": "https://hr.example.com/.well-known/openapi.json"
        },
        "createdAt": "2026-06-18T10:10:00Z",
        "updatedAt": "2026-06-18T10:10:00Z"
      }
    }
  ],
  "schemaDrift": [],
  "metadata": {
    "discovered_at": "2026-06-18T10:10:00Z"
  }
}