Integration Dependency

States that the system can integrate with external systems to achieve an integration purpose

Application DependenciesCloud NativeIntegrationResearchSpecificationsWorkload Specifications

Properties

Name	Type	Description
ordId	string
localId	string
correlationIds	array
title	string
shortDescription	string
description	string
partOfPackage	string
partOfGroups	array
version	object
lastUpdate	string
visibility	object
releaseStatus	object
sunsetDate	string
successors	array
mandatory	boolean	Whether the integration dependency is mandatory
aspects	array
relatedIntegrationDependencies	array
links	array
tags	array
labels	object
documentationLabels	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IntegrationDependency",
  "title": "Integration Dependency",
  "type": "object",
  "description": "States that the system can integrate with external systems to achieve an integration purpose",
  "required": [
    "ordId",
    "title",
    "version",
    "releaseStatus",
    "visibility",
    "partOfPackage",
    "mandatory"
  ],
  "properties": {
    "ordId": {
      "type": "string",
      "pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):(integrationDependency):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
      "maxLength": 255
    },
    "localId": {
      "type": "string",
      "maxLength": 255
    },
    "correlationIds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CorrelationId"
      }
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "shortDescription": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "minLength": 1
    },
    "partOfPackage": {
      "type": "string",
      "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(package):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
      "maxLength": 255
    },
    "partOfGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupId"
      }
    },
    "version": {
      "$ref": "#/components/schemas/SemVer"
    },
    "lastUpdate": {
      "type": "string",
      "format": "date-time"
    },
    "visibility": {
      "$ref": "#/components/schemas/Visibility"
    },
    "releaseStatus": {
      "$ref": "#/components/schemas/ReleaseStatus"
    },
    "sunsetDate": {
      "type": "string",
      "format": "date-time"
    },
    "successors": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(integrationDependency):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
        "maxLength": 255
      }
    },
    "mandatory": {
      "type": "boolean",
      "description": "Whether the integration dependency is mandatory"
    },
    "aspects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IntegrationAspect"
      }
    },
    "relatedIntegrationDependencies": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):(integrationDependency):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$"
      }
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Link"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    },
    "labels": {
      "$ref": "#/components/schemas/Labels"
    },
    "documentationLabels": {
      "$ref": "#/components/schemas/DocumentationLabels"
    }
  }
}