# cloud.pyroclastic.status.maintenance

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

✓ This is the authoritative definition for this NSID.

## Description

Planned pyroclastic.cloud maintenance work. This lexicon is 'community.lexicon.calendar.event'-like.

## Links

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

## Definitions

### `cloud.pyroclastic.status.maintenance`

**Type**: `record`

The key of the maintenance event.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | A brief one-line summary of the maintenance work. |
| `endsAt` | `string` (datetime) | Yes | When the maintenance window ends; set to the actual end once the work finishes. |
| `status` | `ref` → `community.lexicon.calendar.event#status` | No | The status of the maintenance work. |
| `startsAt` | `string` (datetime) | Yes | When the maintenance window starts. |
| `createdAt` | `string` (datetime) | Yes | When the maintenance window is announced. |
| `components` | `array` | No | What the work affects, as component records. Empty or absent means everything. |
| `description` | `string` | No | More information about the maintenance work including impact, size, and scope. |

## Raw Schema

```json
{
  "id": "cloud.pyroclastic.status.maintenance",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "startsAt",
          "endsAt",
          "createdAt"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 640,
            "description": "A brief one-line summary of the maintenance work.",
            "maxGraphemes": 64
          },
          "endsAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the maintenance window ends; set to the actual end once the work finishes."
          },
          "status": {
            "ref": "community.lexicon.calendar.event#status",
            "type": "ref",
            "description": "The status of the maintenance work."
          },
          "startsAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the maintenance window starts."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the maintenance window is announced."
          },
          "components": {
            "type": "array",
            "items": {
              "ref": "com.atproto.repo.strongRef",
              "type": "ref"
            },
            "maxLength": 32,
            "description": "What the work affects, as component records. Empty or absent means everything."
          },
          "description": {
            "type": "string",
            "maxLength": 3000,
            "description": "More information about the maintenance work including impact, size, and scope.",
            "maxGraphemes": 1000
          }
        }
      },
      "description": "The key of the maintenance event."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Planned pyroclastic.cloud maintenance work. This lexicon is 'community.lexicon.calendar.event'-like."
}
```