lol.dids.sites.tile

ngerakines.me

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
icon blob Optional

No description available.

maxSize: 1.0 MB
name string Required

Display name; limits match the Web Tiles specification.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
params array of ref #param Optional

Parameters a binding site must or may supply. Names are unique within a tile.

maxLength: 32 items
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "content"
    ],
    "properties": {
      "icon": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 1048576
      },
      "name": {
        "type": "string",
        "maxLength": 1000,
        "description": "Display name; limits match the Web Tiles specification.",
        "maxGraphemes": 100
      },
      "params": {
        "type": "array",
        "items": {
          "ref": "#param",
          "type": "ref"
        },
        "maxLength": 32,
        "description": "Parameters a binding site must or may supply. Names are unique within a tile."
      },
      "content": {
        "ref": "lol.dids.sites.defs#manifest",
        "type": "ref",
        "description": "The tile's resources. Must name the bundle and contain a '/' entry."
      },
      "description": {
        "type": "string",
        "maxLength": 3000,
        "maxGraphemes": 300
      }
    }
  }
}
itemSchema object

Element type of an array parameter: any #param type except array, with the same constraint fields.

Properties

accept array of string Optional

No description available.

maxLength: 16 items
enum array of string Optional

No description available.

maxLength: 64 items
format string Optional

No description available.

Known values: at-identifier, at-uri, cid, datetime, did, handle, language, nsid, record-key, tid, uri
knownValues array of string Optional

No description available.

maxLength: 64 items
maxGraphemes integer Optional

No description available.

minimum: 1
maxLength integer Optional

No description available.

minimum: 1
maxSize integer Optional

No description available.

minimum: 1
maximum integer Optional

No description available.

minimum integer Optional

No description available.

type string Required

No description available.

maxLength: 317 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "enum": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64
    },
    "type": {
      "type": "string",
      "maxLength": 317
    },
    "accept": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 16
    },
    "format": {
      "type": "string",
      "knownValues": [
        "at-identifier",
        "at-uri",
        "cid",
        "datetime",
        "did",
        "handle",
        "language",
        "nsid",
        "record-key",
        "tid",
        "uri"
      ]
    },
    "maxSize": {
      "type": "integer",
      "minimum": 1
    },
    "maximum": {
      "type": "integer"
    },
    "minimum": {
      "type": "integer"
    },
    "maxLength": {
      "type": "integer",
      "minimum": 1
    },
    "knownValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64
    },
    "maxGraphemes": {
      "type": "integer",
      "minimum": 1
    }
  },
  "description": "Element type of an array parameter: any #param type except array, with the same constraint fields."
}
param object

A parameter a binding site supplies. type is a Lexicon primitive or an NSID; the constraint fields mirror Lexicon's own and apply only where Lexicon applies them — a constraint on a type it does not govern makes the tile invalid.

Properties

accept array of string Optional

blob: accepted MIME types, wildcards as in Lexicon (image/*).

maxLength: 16 items
description string Optional

No description available.

maxLength: 1000 bytes
enum array of string Optional

string: closed set of permitted values.

maxLength: 64 items
format string Optional

string: Lexicon string format.

Known values: at-identifier, at-uri, cid, datetime, did, handle, language, nsid, record-key, tid, uri
items ref #itemSchema Optional

array: the element type. Required when type is array, forbidden otherwise. One level: an item is never itself an array.

knownValues array of string Optional

string: open, advisory set.

maxLength: 64 items
maxGraphemes integer Optional

string.

minimum: 1
maxLength integer Optional

string: maximum UTF-8 bytes; array: maximum item count.

minimum: 1
maxSize integer Optional

blob: maximum size in bytes.

minimum: 1
maximum integer Optional

integer.

minimum integer Optional

integer.

name string Required

Key in the site record's parameters map. Matches [A-Za-z][A-Za-z0-9_]*; must not begin with an underscore.

maxLength: 64 bytes
required boolean Optional

Default false. An absent optional parameter is simply absent; tile code defaults it.

type string Required

One of string, integer, boolean, blob, array — or an NSID naming the record type a value must carry as its $type, which may also be supplied by strong reference.

maxLength: 317 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "enum": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64,
      "description": "string: closed set of permitted values."
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "Key in the site record's parameters map. Matches [A-Za-z][A-Za-z0-9_]*; must not begin with an underscore."
    },
    "type": {
      "type": "string",
      "maxLength": 317,
      "description": "One of string, integer, boolean, blob, array — or an NSID naming the record type a value must carry as its $type, which may also be supplied by strong reference."
    },
    "items": {
      "ref": "#itemSchema",
      "type": "ref",
      "description": "array: the element type. Required when type is array, forbidden otherwise. One level: an item is never itself an array."
    },
    "accept": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 16,
      "description": "blob: accepted MIME types, wildcards as in Lexicon (image/*)."
    },
    "format": {
      "type": "string",
      "description": "string: Lexicon string format.",
      "knownValues": [
        "at-identifier",
        "at-uri",
        "cid",
        "datetime",
        "did",
        "handle",
        "language",
        "nsid",
        "record-key",
        "tid",
        "uri"
      ]
    },
    "maxSize": {
      "type": "integer",
      "minimum": 1,
      "description": "blob: maximum size in bytes."
    },
    "maximum": {
      "type": "integer",
      "description": "integer."
    },
    "minimum": {
      "type": "integer",
      "description": "integer."
    },
    "required": {
      "type": "boolean",
      "description": "Default false. An absent optional parameter is simply absent; tile code defaults it."
    },
    "maxLength": {
      "type": "integer",
      "minimum": 1,
      "description": "string: maximum UTF-8 bytes; array: maximum item count."
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "knownValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64,
      "description": "string: open, advisory set."
    },
    "maxGraphemes": {
      "type": "integer",
      "minimum": 1,
      "description": "string."
    }
  },
  "description": "A parameter a binding site supplies. type is a Lexicon primitive or an NSID; the constraint fields mirror Lexicon's own and apply only where Lexicon applies them — a constraint on a type it does not govern makes the tile invalid."
}

Lexicon Garden

@