Announcement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-announcement-schema.json",
  "title": "Announcement",
  "description": "A message about an impactful operational event.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-announcement-api-openapi.yml#/components/schemas/Announcement",
  "allOf": [
    {
      "$ref": "#/$defs/BaseAnnouncement"
    },
    {
      "properties": {
        "additionalInformation": {
          "description": "Additional information about the event, expressed by using Markdown language and included in the\ndetails view of an announcement. Additional information might include remediation steps or\nanswers to frequently asked questions. Avoid entering confidential information.\n",
          "type": "string"
        },
        "affectedResources": {
          "description": "The list of resources, if any, affected by the event described in the announcement.",
          "items": {
            "$ref": "#/$defs/AffectedResource"
          },
          "type": "array"
        },
        "description": {
          "description": "A detailed explanation of the event, expressed by using Markdown language. Avoid entering\nconfidential information.\n",
          "type": "string"
        }
      }
    }
  ],
  "x-example": "{\n  \"type\" : \"Announcement\",\n  \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"referenceTicketNumber\" : \"ANN-123\",\n  \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n  \"timeOneTitle\" : \"Time Started\",\n  \"timeOneValue\" : \"2019-01-01T21:00:00.000Z\",\n  \"timeTwoTitle\" : \"Time Ended\",\n  \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n  \"services\" : [ \"Compute\" ],\n  \"affectedRegions\" : [ \"us-ashburn-1\" ],\n  \"announcementType\" : \"ACTION_REQUIRED\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"isBanner\" : false,\n  \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n  \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\",\n  \"description\" : \"All versions of Linux OS have been patched for a security vulnerability. However, existing instances deployed prior to January 1, 2019 require customers to apply a patch themselves.\\nReview the list of impacted resources to determine which instances require action.\",\n  \"additionalInformation\" : \"For more information about the vulnerability, see CVE 12345.\",\n  \"followups\" : [ ],\n  \"affectedResources\" : [\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampler2amtptcvblufks3mzzajtwkcxcu4mbjc3fauxwqo6nvpjqr2mb3a\",\n      \"resourceName\" : \"OCIULADMIN\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.examplert3fvrwrmylfhtcvbiyebg4sqiqjytb3iph64v3b6tfauxma5koha\",\n      \"resourceName\" : \"1234567:INTEGRATION:OICDVQSic:wls:vm-1\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampler52l2kcvb6aicisbg4arsedumiwao35p4faux5p5lkuuoq76nenhq\",\n      \"resourceName\" : \"3456789:wtss:QA1234Auto2QSwtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.examplerz7g4b5bcvbnb7txuiek7tjbytffauxypdx4tp4oicxdmwoksiujq\",\n      \"resourceName\" : \"9876543:wtss:Prod4321Auto1wtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    },\n    {\n      \"resourceId\" : \"ocid1.instance.oc1.iad.exampleroww4scvb2zvtnyin6oh5ngd2uuwgg3g5fmnq4w3rszfauxy6diva\",\n      \"resourceName\" : \"7654321:wtss:VBQSwtss:NGINX:vm-2\",\n      \"region\" : \"us-ashburn-1\"\n    }\n  ]\n}\n",
  "$defs": {
    "AffectedResource": {
      "description": "The resource affected by the event described in the announcement.\n",
      "properties": {
        "additionalProperties": {
          "description": "Additional properties associated with the resource.",
          "items": {
            "$ref": "#/$defs/Property"
          },
          "type": "array"
        },
        "region": {
          "description": "The region where the affected resource exists.",
          "type": "string"
        },
        "resourceId": {
          "description": "The OCID of the affected resource.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "resourceName": {
          "description": "The friendly name of the resource.",
          "type": "string"
        }
      },
      "required": [
        "resourceId",
        "resourceName",
        "region"
      ],
      "type": "object",
      "x-example": "{\n  \"resourceId\" : \"ocid1.instance.oc1.iad.exampler2amtptcvblufks3mzzajtwkcxcu4mbjc3fauxwqo6nvpjqr2mb3a\",\n  \"resourceName\" : \"OCIULADMIN\",\n  \"region\" : \"us-ashburn-1\"\n}\n"
    },
    "BaseAnnouncement": {
      "description": "Incident information that forms the basis of an announcement. Avoid entering confidential information.",
      "properties": {
        "affectedRegions": {
          "description": "Impacted regions.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "announcementType": {
          "description": "The type of announcement. An announcement's type signals its severity.",
          "enum": [
            "ACTION_RECOMMENDED",
            "ACTION_REQUIRED",
            "EMERGENCY_CHANGE",
            "EMERGENCY_MAINTENANCE",
            "EMERGENCY_MAINTENANCE_COMPLETE",
            "EMERGENCY_MAINTENANCE_EXTENDED",
            "EMERGENCY_MAINTENANCE_RESCHEDULED",
            "INFORMATION",
            "PLANNED_CHANGE",
            "PLANNED_CHANGE_COMPLETE",
            "PLANNED_CHANGE_EXTENDED",
            "PLANNED_CHANGE_RESCHEDULED",
            "PRODUCTION_EVENT_NOTIFICATION",
            "SCHEDULED_MAINTENANCE"
          ],
          "type": "string"
        },
        "chainId": {
          "description": "The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.",
          "type": "string"
        },
        "environmentName": {
          "description": "The name of the environment that this announcement pertains to.\n",
          "type": "string"
        },
        "id": {
          "description": "The OCID of the announcement.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "isBanner": {
          "description": "Whether the announcement is displayed as a banner in the console.",
          "type": "boolean"
        },
        "lifecycleState": {
          "description": "The current lifecycle state of the announcement.",
          "enum": [
            "ACTIVE",
            "INACTIVE"
          ],
          "type": "string"
        },
        "platformType": {
          "description": "The platform type that this announcement pertains to.\n",
          "enum": [
            "IAAS",
            "SAAS",
            "PAAS"
          ],
          "type": "string"
        },
        "referenceTicketNumber": {
          "description": "The reference Jira ticket number.",
          "type": "string"
        },
        "services": {
          "description": "Impacted Oracle Cloud Infrastructure services.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "summary": {
          "description": "A summary of the issue. A summary might appear in the console banner view of the announcement or in\nan email subject line. Avoid entering confidential information.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "timeCreated": {
          "description": "The date and time the announcement was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-01-01T17:43:01.389+0000`\n",
          "format": "date-time",
          "type": "string"
        },
        "timeOneTitle": {
          "description": "The label associated with an initial time value.\nExample: `Time Started`\n",
          "type": "string"
        },
        "timeOneType": {
          "description": "The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English.\nExample: `START_TIME`\n",
          "enum": [
            "ACTION_REQUIRED_BY",
            "NEW_START_TIME",
            "ORIGINAL_END_TIME",
            "REPORT_DATE",
            "START_TIME",
            "TIME_DETECTED"
          ],
          "type": "string"
        },
        "timeOneValue": {
          "description": "The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning\ncan vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.\n",
          "format": "date-time",
          "type": "string"
        },
        "timeTwoTitle": {
          "description": "The label associated with a second time value.\nExample: `Time Ended`\n",
          "type": "string"
        },
        "timeTwoType": {
          "description": "The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English.\nExample: `END_TIME`\n",
          "enum": [
            "END_TIME",
            "NEW_END_TIME",
            "ESTIMATED_END_TIME"
          ],
          "type": "string"
        },
        "timeTwoValue": {
          "description": "The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning\ncan vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.\n",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The date and time the announcement was last updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-01-01T17:43:01.389+0000`\n",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "The entity type, which is either an announcement or the summary representation of an announcement.",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "id",
        "referenceTicketNumber",
        "summary",
        "description",
        "announcementType",
        "lifecycleState",
        "isBanner",
        "type",
        "services",
        "affectedRegions"
      ],
      "x-example": "{\n  \"type\" : \"Announcement\",\n  \"id\" : \"ocid1.announcement.region1..examplear73oue4jdywjjvietoc6im3cvb6xae4falm3faux5us3iwra3t6q\",\n  \"referenceTicketNumber\" : \"ANN-123\",\n  \"summary\" : \"Patch required for all Linux OS v20 and v21 versions deployed before January 1, 2019.\",\n  \"timeOneTitle\" : \"Time Started\",\n  \"timeOneType\"  : \"START_TIME\",\n  \"timeOneValue\" : \"2019-01-01T21:00:00.000Z\",\n  \"timeTwoTitle\" : \"Time Ended\",\n  \"timeTwoType \" : \"END_TIME\",\n  \"timeTwoValue\" : \"2019-01-28T21:15:00.000Z\",\n  \"services\" : [ \"Compute\" ],\n  \"affectedRegions\" : [ \"us-ashburn-1\" ],\n  \"announcementType\" : \"ACTION_REQUIRED\",\n  \"lifecycleState\" : \"ACTIVE\",\n  \"isBanner\" : false,\n  \"timeCreated\" : \"2019-01-01T23:29:32.072Z\",\n  \"timeUpdated\" : \"2019-01-06T00:47:26.198Z\"\n}\n"
    },
    "Property": {
      "description": "A generic property that might be associated with the affected resource.\n",
      "properties": {
        "name": {
          "description": "The name of the property.",
          "type": "string"
        },
        "value": {
          "description": "The value of the property.",
          "type": "string"
        }
      },
      "required": [
        "name",
        "value"
      ],
      "type": "object"
    }
  }
}