at.inlay.defs

inlay.at

Documentation

cachePolicy object

Cache lifetime and invalidation tags returned by XRPC components.

Properties

life string Optional

How frequently the underlying data changes

maxLength: 32 bytes
Known values: seconds, minutes, hours, max
tags array of union Optional

Data dependencies for cache invalidation

Known types:
View raw schema 
{
  "type": "object",
  "properties": {
    "life": {
      "type": "string",
      "maxLength": 32,
      "description": "How frequently the underlying data changes",
      "knownValues": [
        "seconds",
        "minutes",
        "hours",
        "max"
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "refs": [
          "#tagRecord",
          "#tagLink"
        ],
        "type": "union"
      },
      "description": "Data dependencies for cache invalidation"
    }
  },
  "description": "Cache lifetime and invalidation tags returned by XRPC components."
}
element object

A renderable Inlay element.

Properties

key string Optional

Stable key that identifies the component among its siblings.

maxLength: 256 bytes
props unknown Optional

Properties to pass to the component.

type string nsid Required

NSID of the component to render.

View raw schema 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 256,
      "description": "Stable key that identifies the component among its siblings."
    },
    "type": {
      "type": "string",
      "format": "nsid",
      "description": "NSID of the component to render."
    },
    "props": {
      "type": "unknown",
      "description": "Properties to pass to the component."
    }
  },
  "description": "A renderable Inlay element."
}
response object

Standard response from a component render call.

Properties

cache ref #cachePolicy Required

Cache lifetime and invalidation tags

node ref #element Required

Rendered element tree

View raw schema 
{
  "type": "object",
  "required": [
    "node",
    "cache"
  ],
  "properties": {
    "node": {
      "ref": "#element",
      "type": "ref",
      "description": "Rendered element tree"
    },
    "cache": {
      "ref": "#cachePolicy",
      "type": "ref",
      "description": "Cache lifetime and invalidation tags"
    }
  },
  "description": "Standard response from a component render call."
}
tagLink object

Cache tag: depend on backlink relationships to a subject.

Properties

from string nsid Optional

Collection NSID of the linking records. Omit for any collection.

subject string at-uri Required

Subject AT URI that is linked to

View raw schema 
{
  "type": "object",
  "required": [
    "subject"
  ],
  "properties": {
    "from": {
      "type": "string",
      "format": "nsid",
      "description": "Collection NSID of the linking records. Omit for any collection."
    },
    "subject": {
      "type": "string",
      "format": "at-uri",
      "description": "Subject AT URI that is linked to"
    }
  },
  "description": "Cache tag: depend on backlink relationships to a subject."
}
tagRecord object

Cache tag: depend on a specific record, collection, or identity.

Properties

uri string at-uri Required

AT URI at record, collection, or identity granularity

View raw schema 
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI at record, collection, or identity granularity"
    }
  },
  "description": "Cache tag: depend on a specific record, collection, or identity."
}
viaValtown object

No description available.

Properties

valId string Required

Val Town val UUID

maxLength: 128 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "valId"
  ],
  "properties": {
    "valId": {
      "type": "string",
      "maxLength": 128,
      "description": "Val Town val UUID"
    }
  }
}

Lexicon Garden

@