UpdateChannelDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-update-channel-details-schema.json",
  "title": "UpdateChannelDetails",
  "description": "Details required to update 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/UpdateChannelDetails",
  "properties": {
    "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"
    },
    "description": {
      "description": "User provided description of the Channel.",
      "maxLength": 400,
      "minLength": 1,
      "type": "string"
    },
    "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"
    },
    "isEnabled": {
      "default": true,
      "description": "Whether the Channel should be enabled or disabled. Enabling a previously\ndisabled Channel will cause the Channel to be started. Conversely, disabling\na previously enabled Channel will stop the Channel. Both operations are\nexecuted asynchronously.\n",
      "type": "boolean"
    },
    "source": {
      "$ref": "#/$defs/UpdateChannelSourceDetails"
    },
    "target": {
      "$ref": "#/$defs/UpdateChannelTargetDetails"
    }
  },
  "$defs": {
    "UpdateChannelSourceDetails": {
      "description": "Parameters detailing how to provision the source for the given Channel.",
      "properties": {
        "sourceType": {
          "description": "The specific source identifier.\n",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/ChannelSource/sourceType"
        }
      },
      "required": [
        "sourceType"
      ]
    },
    "UpdateChannelTargetDetails": {
      "description": "Parameters detailing how to provision the target for the given Channel.",
      "properties": {
        "targetType": {
          "description": "The specific targetType identifier.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/ChannelTarget/targetType"
        }
      },
      "required": [
        "targetType"
      ]
    }
  }
}