ChannelSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-channel-summary-schema.json",
  "title": "ChannelSummary",
  "description": "Summary of a Channel.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-channels-api-openapi.yml#/components/schemas/ChannelSummary",
  "properties": {
    "compartmentId": {
      "description": "The OCID of the compartment.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string",
      "x-default-description": "If not specified by the user it will assume the value of the compartment of\nthe target DB System.\n"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of predefined tag keys. These predefined keys are scoped to namespaces.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "The user-friendly name for the Channel. It does not have to be unique.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The OCID of the Channel.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "isEnabled": {
      "default": true,
      "description": "Whether the Channel has been enabled by the user.",
      "type": "boolean"
    },
    "lifecycleDetails": {
      "description": "A message describing the state of the Channel.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The state of the Channel.",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/Channel/lifecycleState"
    },
    "source": {
      "$ref": "#/$defs/ChannelSource"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "target": {
      "$ref": "#/$defs/ChannelTarget"
    },
    "timeCreated": {
      "description": "The date and time the Channel was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the Channel was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "isEnabled",
    "source",
    "target",
    "lifecycleState",
    "displayName",
    "timeCreated",
    "timeUpdated"
  ],
  "$defs": {
    "ChannelSource": {
      "description": "Parameters detailing how to provision the source for the given Channel.",
      "properties": {
        "sourceType": {
          "description": "The specific source identifier.",
          "enum": [
            "MYSQL"
          ],
          "type": "string"
        }
      },
      "required": [
        "sourceType"
      ]
    },
    "ChannelTarget": {
      "description": "Details about the Channel target.",
      "properties": {
        "targetType": {
          "description": "The specific target identifier.",
          "enum": [
            "DBSYSTEM"
          ],
          "type": "string"
        }
      },
      "required": [
        "targetType"
      ]
    }
  }
}