# cloud.pyroclastic.status.incident

> Published by [ops.dids.lol](https://lexicon.garden/identity/did:plc:qnyj44s7iujxusfvc574dfwm)

✓ This is the authoritative definition for this NSID.

## Description

A pyroclastic.cloud incident. This lexicon is 'community.lexicon.calendar.event'-like.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qnyj44s7iujxusfvc574dfwm/cloud.pyroclastic.status.incident)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qnyj44s7iujxusfvc574dfwm/cloud.pyroclastic.status.incident/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qnyj44s7iujxusfvc574dfwm/cloud.pyroclastic.status.incident/examples)

## Definitions

### `cloud.pyroclastic.status.incident`

**Type**: `record`

The key of the incident.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | A brief one-line summary of what is wrong. |
| `endsAt` | `string` (datetime) | No | When the incident ended. Absent implies it is ongoing unless otherwise noted. |
| `updates` | `array` | Yes | The incident timeline. |
| `severity` | `string` | Yes | The severity of the incident |
| `startsAt` | `string` (datetime) | Yes | When the incident started, or was first observed or reported. |
| `createdAt` | `string` (datetime) | Yes | When the incident is opened. |
| `components` | `array` | No | What the incident affects, as component records. |
| `description` | `string` | No | Additional details and information about the incident. |

### `cloud.pyroclastic.status.incident#update`

**Type**: `object`

One entry in an incident's timeline.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `at` | `string` (datetime) | Yes | The time of the update. |
| `text` | `string` | Yes | The update relevant to the incident. |
| `status` | `string` | Yes | The incident's status as of this update. |

## Raw Schema

```json
{
  "id": "cloud.pyroclastic.status.incident",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "severity",
          "startsAt",
          "updates",
          "createdAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 640,
            "description": "A brief one-line summary of what is wrong.",
            "maxGraphemes": 64
          },
          "endsAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the incident ended. Absent implies it is ongoing unless otherwise noted."
          },
          "updates": {
            "type": "array",
            "items": {
              "ref": "#update",
              "type": "ref"
            },
            "maxLength": 128,
            "minLength": 1,
            "description": "The incident timeline."
          },
          "severity": {
            "type": "string",
            "maxLength": 64,
            "description": "The severity of the incident",
            "knownValues": [
              "minor",
              "major"
            ]
          },
          "startsAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the incident started, or was first observed or reported."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the incident is opened."
          },
          "components": {
            "type": "array",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 32,
            "description": "What the incident affects, as component records."
          },
          "description": {
            "type": "string",
            "maxLength": 3000,
            "description": "Additional details and information about the incident.",
            "maxGraphemes": 1000
          }
        }
      },
      "description": "The key of the incident."
    },
    "update": {
      "type": "object",
      "required": [
        "at",
        "status",
        "text"
      ],
      "properties": {
        "at": {
          "type": "string",
          "format": "datetime",
          "description": "The time of the update."
        },
        "text": {
          "type": "string",
          "maxLength": 3000,
          "description": "The update relevant to the incident.",
          "maxGraphemes": 1000
        },
        "status": {
          "type": "string",
          "maxLength": 64,
          "description": "The incident's status as of this update.",
          "knownValues": [
            "reported",
            "investigating",
            "mitigated",
            "resolved"
          ]
        }
      },
      "description": "One entry in an incident's timeline."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "A pyroclastic.cloud incident. This lexicon is 'community.lexicon.calendar.event'-like."
}
```