lol.dids.defs

ngerakines.me

Documentation

blobFailure object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

error string Required

BlobUnavailable, CidMismatch, FetchFailed.

role string Required

No description available.

Known values: manifest, tile, parameter, notFound
sourceDid string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "cid",
    "role",
    "sourceDid",
    "error"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "role": {
      "type": "string",
      "knownValues": [
        "manifest",
        "tile",
        "parameter",
        "notFound"
      ]
    },
    "error": {
      "type": "string",
      "description": "BlobUnavailable, CidMismatch, FetchFailed."
    },
    "sourceDid": {
      "type": "string",
      "format": "did"
    }
  }
}
denylistEntry object

No description available.

Properties

actor string Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

kind string Required

No description available.

Known values: domain, did, uri, cid, pattern, space
reason string Optional

No description available.

subject string Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "subject",
    "kind",
    "createdAt"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "knownValues": [
        "domain",
        "did",
        "uri",
        "cid",
        "pattern",
        "space"
      ]
    },
    "actor": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
dnsInstruction object

No description available.

Properties

name string Required

Fully-qualified record name.

purpose string Optional

No description available.

Known values: ownership, certificate, traffic
required boolean Optional

No description available.

ttl integer Optional

No description available.

type string Required

No description available.

Known values: TXT, CNAME, ALIAS, ANAME, A, AAAA
value string Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "type",
    "name",
    "value"
  ],
  "properties": {
    "ttl": {
      "type": "integer"
    },
    "name": {
      "type": "string",
      "description": "Fully-qualified record name."
    },
    "type": {
      "type": "string",
      "knownValues": [
        "TXT",
        "CNAME",
        "ALIAS",
        "ANAME",
        "A",
        "AAAA"
      ]
    },
    "value": {
      "type": "string"
    },
    "purpose": {
      "type": "string",
      "knownValues": [
        "ownership",
        "certificate",
        "traffic"
      ]
    },
    "required": {
      "type": "boolean"
    }
  }
}
domainEvent object

No description available.

Properties

actor string Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

detail unknown Optional

No description available.

event string Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "event",
    "createdAt"
  ],
  "properties": {
    "actor": {
      "type": "string"
    },
    "event": {
      "type": "string"
    },
    "detail": {
      "type": "unknown"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
domainStatus string

No description available.

Known Values (other values may be valid)
pending verifying verified active failed suspended released
View raw schema
{
  "type": "string",
  "knownValues": [
    "pending",
    "verifying",
    "verified",
    "active",
    "failed",
    "suspended",
    "released"
  ]
}
domainView object

No description available.

Properties

activatedAt string datetime Optional

An RFC 3339 formatted timestamp.

activeCid string cid Optional

A content identifier (CID) referencing immutable data.

activeRev string Optional

No description available.

activeUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

createdAt string datetime Required

An RFC 3339 formatted timestamp.

did string did Required

A decentralized identifier (DID).

domain string Required

No description available.

entryCount integer Optional

No description available.

pendingCid string cid Optional

A validated, prepared record awaiting its commit, if any.

pendingState string Optional

No description available.

Known values: preparing, pending-publication
sourceKind string Optional

No description available.

Known values: inline, tile
space string at-uri Optional

The space the domain is registered to; absent for a DID-registered domain. The serving record is the space authority's.

tileCid string cid Optional

A content identifier (CID) referencing immutable data.

tileUri string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

tls ref #tlsStatus Optional

No description available.

totalBytes integer Optional

No description available.

verifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema
{
  "type": "object",
  "required": [
    "domain",
    "did",
    "status",
    "createdAt"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "tls": {
      "ref": "#tlsStatus",
      "type": "ref"
    },
    "space": {
      "type": "string",
      "format": "at-uri",
      "description": "The space the domain is registered to; absent for a DID-registered domain. The serving record is the space authority's."
    },
    "domain": {
      "type": "string"
    },
    "status": {
      "ref": "#domainStatus",
      "type": "ref"
    },
    "tileCid": {
      "type": "string",
      "format": "cid"
    },
    "tileUri": {
      "type": "string",
      "format": "at-uri"
    },
    "activeCid": {
      "type": "string",
      "format": "cid"
    },
    "activeRev": {
      "type": "string"
    },
    "activeUri": {
      "type": "string",
      "format": "at-uri"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "entryCount": {
      "type": "integer"
    },
    "pendingCid": {
      "type": "string",
      "format": "cid",
      "description": "A validated, prepared record awaiting its commit, if any."
    },
    "sourceKind": {
      "type": "string",
      "knownValues": [
        "inline",
        "tile"
      ]
    },
    "totalBytes": {
      "type": "integer"
    },
    "verifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "activatedAt": {
      "type": "string",
      "format": "datetime"
    },
    "pendingState": {
      "type": "string",
      "knownValues": [
        "preparing",
        "pending-publication"
      ]
    }
  }
}
indexState string

No description available.

Known Values (other values may be valid)
preparing pending-publication expired queued fetching materializing active superseded rejected failed
View raw schema
{
  "type": "string",
  "knownValues": [
    "preparing",
    "pending-publication",
    "expired",
    "queued",
    "fetching",
    "materializing",
    "active",
    "superseded",
    "rejected",
    "failed"
  ]
}
jobView object

No description available.

Properties

action string Required

No description available.

attempts integer Required

No description available.

finishedAt string datetime Optional

An RFC 3339 formatted timestamp.

id integer Required

No description available.

lastError string Optional

No description available.

scheduledAt string datetime Required

An RFC 3339 formatted timestamp.

startedAt string datetime Optional

An RFC 3339 formatted timestamp.

state string Required

No description available.

uri string Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "uri",
    "action",
    "state",
    "attempts",
    "scheduledAt"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "uri": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "action": {
      "type": "string"
    },
    "attempts": {
      "type": "integer"
    },
    "lastError": {
      "type": "string"
    },
    "startedAt": {
      "type": "string",
      "format": "datetime"
    },
    "finishedAt": {
      "type": "string",
      "format": "datetime"
    },
    "scheduledAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
missingBlob object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

role string Required

No description available.

Known values: manifest, tile, parameter, notFound
sourceDid string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "cid",
    "role",
    "sourceDid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "role": {
      "type": "string",
      "knownValues": [
        "manifest",
        "tile",
        "parameter",
        "notFound"
      ]
    },
    "sourceDid": {
      "type": "string",
      "format": "did"
    }
  }
}
preparationStatus object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

failed array of ref#blobFailure Required

No description available.

fetched integer Required

No description available.

pending integer Required

No description available.

state string Required

No description available.

Known values: preparing, pending-publication, expired
View raw schema
{
  "type": "object",
  "required": [
    "state",
    "cid",
    "fetched",
    "pending",
    "failed"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "state": {
      "type": "string",
      "knownValues": [
        "preparing",
        "pending-publication",
        "expired"
      ]
    },
    "failed": {
      "type": "array",
      "items": {
        "ref": "#blobFailure",
        "type": "ref"
      }
    },
    "fetched": {
      "type": "integer"
    },
    "pending": {
      "type": "integer"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
siteView object

No description available.

Properties

activatedAt string datetime Required

An RFC 3339 formatted timestamp.

cid string cid Required

A content identifier (CID) referencing immutable data.

did string did Required

A decentralized identifier (DID).

domain string Required

No description available.

rev string Required

No description available.

sourceKind string Required

No description available.

Known values: inline, tile
space string at-uri Optional

Present for a site published from a space; attribution survives the plane.

tile ref #tileView Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "domain",
    "did",
    "uri",
    "cid",
    "rev",
    "activatedAt",
    "sourceKind"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "rev": {
      "type": "string"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "tile": {
      "ref": "#tileView",
      "type": "ref"
    },
    "space": {
      "type": "string",
      "format": "at-uri",
      "description": "Present for a site published from a space; attribution survives the plane."
    },
    "domain": {
      "type": "string"
    },
    "sourceKind": {
      "type": "string",
      "knownValues": [
        "inline",
        "tile"
      ]
    },
    "activatedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
spaceEvent object

No description available.

Properties

actor string did Optional

A decentralized identifier (DID).

at string datetime Required

An RFC 3339 formatted timestamp.

cid string cid Optional

A content identifier (CID) referencing immutable data.

kind string Required

No description available.

Known values: record.created, record.updated, record.deleted, site.activated, site.deactivated, tile.ready, tile.incomplete, tile.deleted, access.granted, access.expired, registration.renewed, registration.lapsed, app-not-allowed, space.deleted
seq integer Required

No description available.

space string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

subject string Optional

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "seq",
    "space",
    "kind",
    "at"
  ],
  "properties": {
    "at": {
      "type": "string",
      "format": "datetime"
    },
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "seq": {
      "type": "integer"
    },
    "kind": {
      "type": "string",
      "knownValues": [
        "record.created",
        "record.updated",
        "record.deleted",
        "site.activated",
        "site.deactivated",
        "tile.ready",
        "tile.incomplete",
        "tile.deleted",
        "access.granted",
        "access.expired",
        "registration.renewed",
        "registration.lapsed",
        "app-not-allowed",
        "space.deleted"
      ]
    },
    "actor": {
      "type": "string",
      "format": "did"
    },
    "space": {
      "type": "string",
      "format": "at-uri"
    },
    "subject": {
      "type": "string"
    }
  }
}
spaceSyncState string

No description available.

Known Values (other values may be valid)
connecting syncing synced credential-expired registration-lapsed app-not-allowed authority-unreachable deleted disconnected
View raw schema
{
  "type": "string",
  "knownValues": [
    "connecting",
    "syncing",
    "synced",
    "credential-expired",
    "registration-lapsed",
    "app-not-allowed",
    "authority-unreachable",
    "deleted",
    "disconnected"
  ]
}
spaceView object

No description available.

Properties

accessExpiresAt string datetime Optional

When bard's current space credential expires; absent when bard holds none.

accessGrantedBy string did Optional

A decentralized identifier (DID).

appAccess string Optional

No description available.

Known values: open, allow-list, unknown
authority string did Required

A decentralized identifier (DID).

connectedAt string datetime Required

An RFC 3339 formatted timestamp.

domainCount integer Optional

No description available.

headRev string Optional

No description available.

lastCheckedAt string datetime Optional

An RFC 3339 formatted timestamp.

lastNotifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

policy string Optional

No description available.

Known values: public, member-list, managing-app, unknown
queuedNotifications integer Optional

Receipts waiting for a credential.

registrationExpiresAt string datetime Optional

An RFC 3339 formatted timestamp.

skey string Required

No description available.

tileCount integer Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "authority",
    "skey",
    "syncState",
    "connectedAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "skey": {
      "type": "string"
    },
    "policy": {
      "type": "string",
      "knownValues": [
        "public",
        "member-list",
        "managing-app",
        "unknown"
      ]
    },
    "headRev": {
      "type": "string"
    },
    "appAccess": {
      "type": "string",
      "knownValues": [
        "open",
        "allow-list",
        "unknown"
      ]
    },
    "authority": {
      "type": "string",
      "format": "did"
    },
    "syncState": {
      "ref": "#spaceSyncState",
      "type": "ref"
    },
    "tileCount": {
      "type": "integer"
    },
    "connectedAt": {
      "type": "string",
      "format": "datetime"
    },
    "domainCount": {
      "type": "integer"
    },
    "lastCheckedAt": {
      "type": "string",
      "format": "datetime"
    },
    "lastNotifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "accessExpiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "When bard's current space credential expires; absent when bard holds none."
    },
    "accessGrantedBy": {
      "type": "string",
      "format": "did"
    },
    "queuedNotifications": {
      "type": "integer",
      "description": "Receipts waiting for a credential."
    },
    "registrationExpiresAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
tileView object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

description string Optional

No description available.

did string did Required

A decentralized identifier (DID).

entryCount integer Optional

No description available.

iconUrl string uri Optional

https://dids.lol/xrpc/lol.dids.sites.getTileIcon?cid={cid}; absent if the tile has no icon.

indexedAt string datetime Required

An RFC 3339 formatted timestamp.

latestCid string cid Optional

The newest indexed version at this URI, when it differs from cid.

name string Required

No description available.

space string at-uri Optional

Present for a space tile; never on the public surface.

state string Required

No description available.

Known values: indexing, ready, incomplete, rejected, suspended, deleted
totalBytes integer Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "did",
    "name",
    "state",
    "indexedAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "did": {
      "type": "string",
      "format": "did"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "space": {
      "type": "string",
      "format": "at-uri",
      "description": "Present for a space tile; never on the public surface."
    },
    "state": {
      "type": "string",
      "knownValues": [
        "indexing",
        "ready",
        "incomplete",
        "rejected",
        "suspended",
        "deleted"
      ]
    },
    "params": {
      "type": "array",
      "items": {
        "ref": "lol.dids.sites.tile#param",
        "type": "ref"
      }
    },
    "iconUrl": {
      "type": "string",
      "format": "uri",
      "description": "https://dids.lol/xrpc/lol.dids.sites.getTileIcon?cid={cid}; absent if the tile has no icon."
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "latestCid": {
      "type": "string",
      "format": "cid",
      "description": "The newest indexed version at this URI, when it differs from cid."
    },
    "entryCount": {
      "type": "integer"
    },
    "totalBytes": {
      "type": "integer"
    },
    "description": {
      "type": "string"
    }
  }
}
tlsStatus string

No description available.

Known Values (other values may be valid)
none pending issued renewing failed
View raw schema
{
  "type": "string",
  "knownValues": [
    "none",
    "pending",
    "issued",
    "renewing",
    "failed"
  ]
}
tlsView object

No description available.

Properties

expiresAt string datetime Optional

An RFC 3339 formatted timestamp.

issuedAt string datetime Optional

An RFC 3339 formatted timestamp.

lastError string Optional

No description available.

status ref #tlsStatus Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "ref": "#tlsStatus",
      "type": "ref"
    },
    "issuedAt": {
      "type": "string",
      "format": "datetime"
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime"
    },
    "lastError": {
      "type": "string"
    }
  }
}
validationError object

No description available.

Properties

message string Required

No description available.

name string Required

A DESIGN.md §3.8 error name, e.g. DuplicatePath, RedirectTargetNotFound, ParameterTypeMismatch.

path string Optional

JSON Pointer into the record, when the error concerns one field or entry.

View raw schema
{
  "type": "object",
  "required": [
    "name",
    "message"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "A DESIGN.md §3.8 error name, e.g. DuplicatePath, RedirectTargetNotFound, ParameterTypeMismatch."
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer into the record, when the error concerns one field or entry."
    },
    "message": {
      "type": "string"
    }
  }
}
verificationCheck object

No description available.

Properties

checkedAt string datetime Required

An RFC 3339 formatted timestamp.

detail string Optional

No description available.

name string Required

No description available.

Known values: ownership, traffic, conflict
passed boolean Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "name",
    "passed",
    "checkedAt"
  ],
  "properties": {
    "name": {
      "type": "string",
      "knownValues": [
        "ownership",
        "traffic",
        "conflict"
      ]
    },
    "detail": {
      "type": "string"
    },
    "passed": {
      "type": "boolean"
    },
    "checkedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
verificationView object

No description available.

Properties

lastCheckedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema
{
  "type": "object",
  "required": [
    "status",
    "checks"
  ],
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "ref": "#verificationCheck",
        "type": "ref"
      }
    },
    "status": {
      "ref": "#domainStatus",
      "type": "ref"
    },
    "lastCheckedAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}

Lexicon Garden

@