dev.tsunagite.types

tsunagite.dev

Documentation

indexable object

A named value with a numeric index for sorting.

Properties

id string record-key Required

The internal ID for the value, limited to the RecordKey character set.

maxLength: 32 bytesminLength: 1 bytes
index integer Required

The numeric index used for sorting.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "name",
    "index"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "record-key",
      "maxLength": 32,
      "minLength": 1,
      "description": "The internal ID for the value, limited to the RecordKey character set."
    },
    "name": {
      "ref": "dev.tsunagite.translatable",
      "type": "ref",
      "description": "The human-readable name of the value for displaying in UIs."
    },
    "index": {
      "type": "integer",
      "description": "The numeric index used for sorting."
    }
  },
  "description": "A named value with a numeric index for sorting."
}
typedRef object

A typed record reference that does not require a CID hash.

Properties

ref string at-uri Optional

The AT URI of the record this object references.

type string record-key Optional

The type of the record this object references.

View raw schema 
{
  "type": "object",
  "properties": {
    "ref": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT URI of the record this object references."
    },
    "type": {
      "type": "string",
      "format": "record-key",
      "description": "The type of the record this object references."
    }
  },
  "description": "A typed record reference that does not require a CID hash."
}

Lexicon Garden

@