# io.atplan.plan

> Published by [mikehacks.io](https://lexicon.garden/identity/did:plc:li7aafca7mhntzdnrehbezgc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:li7aafca7mhntzdnrehbezgc/io.atplan.plan)
- [Documentation](https://lexicon.garden/lexicon/did:plc:li7aafca7mhntzdnrehbezgc/io.atplan.plan/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:li7aafca7mhntzdnrehbezgc/io.atplan.plan/examples)

## Definitions

### `io.atplan.plan`

**Type**: `record`

A user plan record. Inspired by the Unix .plan file tradition.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `url` | `string` | No | Optional personal or project URL |
| `text` | `string` | Yes | The freeform .plan body |
| `status` | `string` | No | Short availability or mood line |
| `project` | `string` | No | Current project, the .project companion |
| `updatedAt` | `string` (datetime) | Yes | Timestamp of last update |
| `displayName` | `string` | No | Human readable name |

## Raw Schema

```json
{
  "id": "io.atplan.plan",
  "defs": {
    "main": {
      "key": "literal:self",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "text",
          "updatedAt"
        ],
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 512,
            "description": "Optional personal or project URL"
          },
          "text": {
            "type": "string",
            "maxLength": 10000,
            "description": "The freeform .plan body"
          },
          "status": {
            "type": "string",
            "maxLength": 100,
            "description": "Short availability or mood line"
          },
          "project": {
            "type": "string",
            "maxLength": 256,
            "description": "Current project, the .project companion"
          },
          "updatedAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp of last update"
          },
          "displayName": {
            "type": "string",
            "maxLength": 64,
            "description": "Human readable name"
          }
        }
      },
      "description": "A user plan record. Inspired by the Unix .plan file tradition."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```