ResponseDiscoveryOutagesList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/origin-energy/main/json-schema/origin-energy-response-discovery-outages-list-schema.json",
  "title": "ResponseDiscoveryOutagesList",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/origin-energy-data-holder-operations-api-openapi.yml#/components/schemas/ResponseDiscoveryOutagesList",
  "properties": {
    "data": {
      "$ref": "#/$defs/ResponseDiscoveryOutagesList_data"
    },
    "links": {
      "$ref": "#/$defs/Links"
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "required": [
    "data",
    "links"
  ],
  "type": "object",
  "$defs": {
    "DiscoveryOutage": {
      "properties": {
        "outageTime": {
          "description": "Date and time that the outage is scheduled to begin.",
          "type": "string",
          "x-cds-type": "DateTimeString"
        },
        "duration": {
          "description": "Planned duration of the outage. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax).",
          "type": "string",
          "x-cds-type": "ExternalRef"
        },
        "isPartial": {
          "description": "Flag that indicates, if present and set to `true`, that the outage is only partial meaning that only a subset of normally available endpoints will be affected by the outage.",
          "type": "boolean"
        },
        "explanation": {
          "description": "Provides an explanation of the current outage that can be displayed to an end customer.",
          "type": "string"
        }
      },
      "required": [
        "duration",
        "explanation",
        "outageTime"
      ],
      "type": "object"
    },
    "Links": {
      "properties": {
        "self": {
          "description": "Fully qualified link that generated the current response document.",
          "type": "string",
          "x-cds-type": "URIString"
        }
      },
      "required": [
        "self"
      ],
      "type": "object"
    },
    "Meta": {
      "type": "object"
    },
    "ResponseDiscoveryOutagesList_data": {
      "properties": {
        "outages": {
          "description": "List of scheduled outages. Property is mandatory but may contain an empty list if no outages are scheduled.",
          "items": {
            "$ref": "#/$defs/DiscoveryOutage"
          },
          "type": "array"
        }
      },
      "required": [
        "outages"
      ],
      "type": "object"
    }
  }
}