io.atcr.hold.captain Documentation (EN)

main record

Represents the hold's ownership and metadata. Stored as a singleton record at rkey 'self' in the hold's embedded PDS.

Record Key literal:self Fixed literal value

Properties

allowAllCrew boolean Required

Allow any authenticated user to register as crew

deployedAt string datetime Required

RFC3339 timestamp of when the hold was deployed

enableBlueskyPosts boolean Required

Enable Bluesky posts when manifests are pushed

owner string did Required

DID of the hold owner

provider string Optional

Deployment provider (e.g., fly.io, aws, etc.)

maxLength: 64 bytes

public boolean Required

Whether this hold allows public blob reads (pulls) without authentication

region string Optional

S3 region where blobs are stored

maxLength: 64 bytes

View raw schema

{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "owner",
      "public",
      "allowAllCrew",
      "enableBlueskyPosts",
      "deployedAt"
    ],
    "properties": {
      "owner": {
        "type": "string",
        "format": "did",
        "description": "DID of the hold owner"
      },
      "public": {
        "type": "boolean",
        "description": "Whether this hold allows public blob reads (pulls) without authentication"
      },
      "region": {
        "type": "string",
        "maxLength": 64,
        "description": "S3 region where blobs are stored"
      },
      "provider": {
        "type": "string",
        "maxLength": 64,
        "description": "Deployment provider (e.g., fly.io, aws, etc.)"
      },
      "deployedAt": {
        "type": "string",
        "format": "datetime",
        "description": "RFC3339 timestamp of when the hold was deployed"
      },
      "allowAllCrew": {
        "type": "boolean",
        "description": "Allow any authenticated user to register as crew"
      },
      "enableBlueskyPosts": {
        "type": "boolean",
        "description": "Enable Bluesky posts when manifests are pushed"
      }
    }
  },
  "description": "Represents the hold's ownership and metadata. Stored as a singleton record at rkey 'self' in the hold's embedded PDS."
}