zone.stratos.defs

lexicon.northsky.app

Documentation

source object

Indicates this record requires hydration from an external service. The stub record on the PDS contains minimal data; full content is fetched from the service endpoint.

Properties

service string did Required

DID of the hydration service, optionally with fragment identifying the service entry (e.g., 'did:plc:abc123#atproto_pns').

subject ref #subjectRef Required

Reference to the full record at the hydration service.

vary string Required

Indicates when hydration is needed. 'authenticated' means full content requires viewer authentication.

maxLength: 128 bytes
Known values: authenticated, unauthenticated
View raw schema 
{
  "type": "object",
  "required": [
    "vary",
    "subject",
    "service"
  ],
  "properties": {
    "vary": {
      "type": "string",
      "maxLength": 128,
      "description": "Indicates when hydration is needed. 'authenticated' means full content requires viewer authentication.",
      "knownValues": [
        "authenticated",
        "unauthenticated"
      ]
    },
    "service": {
      "type": "string",
      "format": "did",
      "description": "DID of the hydration service, optionally with fragment identifying the service entry (e.g., 'did:plc:abc123#atproto_pns')."
    },
    "subject": {
      "ref": "#subjectRef",
      "type": "ref",
      "description": "Reference to the full record at the hydration service."
    }
  },
  "description": "Indicates this record requires hydration from an external service. The stub record on the PDS contains minimal data; full content is fetched from the service endpoint."
}
subjectRef object

A strong reference to a record, including its content hash for verification.

Properties

cid string cid Required

CID of the full record content for integrity verification.

uri string at-uri Required

AT-URI of the record at the hydration service.

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the full record content for integrity verification."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the record at the hydration service."
    }
  },
  "description": "A strong reference to a record, including its content hash for verification."
}

Lexicon Garden

@