Consumption Bundle

Groups APIs and Events that can be consumed with the same credentials

Application DependenciesCloud NativeIntegrationResearchSpecificationsWorkload Specifications

Properties

Name	Type	Description
ordId	string
localId	string
correlationIds	array
title	string
shortDescription	string
description	string
version	object
lastUpdate	string
visibility	object
credentialExchangeStrategies	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/ConsumptionBundle",
  "title": "Consumption Bundle",
  "type": "object",
  "description": "Groups APIs and Events that can be consumed with the same credentials",
  "required": [
    "ordId",
    "title"
  ],
  "properties": {
    "ordId": {
      "type": "string",
      "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(consumptionBundle):([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
    },
    "version": {
      "$ref": "#/components/schemas/SemVer"
    },
    "lastUpdate": {
      "type": "string",
      "format": "date-time"
    },
    "visibility": {
      "$ref": "#/components/schemas/Visibility"
    },
    "credentialExchangeStrategies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CredentialExchangeStrategy"
      }
    },
    "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"
    }
  }
}