space.highport.sites.tile

lexicons.highport.space

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 must be unique within the 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 must be unique within the tile."
      },
      "content": {
        "ref": "space.highport.sites.defs#manifest",
        "type": "ref",
        "description": "The tile's resources. Must have a bundle name and 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 work like Lexicon's and apply only where Lexicon applies them; using one on a type it does not govern makes the tile invalid.

Properties

accept array of string Optional

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

maxLength: 16 items
description string Optional

No description available.

maxLength: 1000 bytes
enum array of string Optional

For string: a closed set of allowed values.

maxLength: 64 items
format string Optional

For string: a Lexicon string format.

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

For array: the element type. Required when type is array and not allowed otherwise. An item is never itself an array.

knownValues array of string Optional

For string: an open, advisory set of values.

maxLength: 64 items
maxGraphemes integer Optional

For string: the maximum graphemes.

minimum: 1
maxLength integer Optional

For string, the maximum UTF-8 bytes; for array, the maximum number of items.

minimum: 1
maxSize integer Optional

For blob: the maximum size in bytes.

minimum: 1
maximum integer Optional

For integer: the maximum value.

minimum integer Optional

For integer: the minimum value.

name string Required

Key in the site record's parameters map. Must match [A-Za-z][A-Za-z0-9_]*, so it cannot start with an underscore.

maxLength: 64 bytes
required boolean Optional

Defaults to false. An optional parameter that is left out stays absent, and the tile's code supplies the default.

type string Required

One of string, integer, boolean, blob or array, or an NSID naming the $type a value must have. A value of NSID type may also be given by strong reference.

maxLength: 317 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "enum": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64,
      "description": "For string: a closed set of allowed values."
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "Key in the site record's parameters map. Must match [A-Za-z][A-Za-z0-9_]*, so it cannot start with an underscore."
    },
    "type": {
      "type": "string",
      "maxLength": 317,
      "description": "One of string, integer, boolean, blob or array, or an NSID naming the $type a value must have. A value of NSID type may also be given by strong reference."
    },
    "items": {
      "ref": "#itemSchema",
      "type": "ref",
      "description": "For array: the element type. Required when type is array and not allowed otherwise. An item is never itself an array."
    },
    "accept": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 16,
      "description": "For blob: accepted MIME types, with wildcards as in Lexicon (image/*)."
    },
    "format": {
      "type": "string",
      "description": "For string: a Lexicon string format.",
      "knownValues": [
        "at-identifier",
        "at-uri",
        "cid",
        "datetime",
        "did",
        "handle",
        "language",
        "nsid",
        "record-key",
        "tid",
        "uri"
      ]
    },
    "maxSize": {
      "type": "integer",
      "minimum": 1,
      "description": "For blob: the maximum size in bytes."
    },
    "maximum": {
      "type": "integer",
      "description": "For integer: the maximum value."
    },
    "minimum": {
      "type": "integer",
      "description": "For integer: the minimum value."
    },
    "required": {
      "type": "boolean",
      "description": "Defaults to false. An optional parameter that is left out stays absent, and the tile's code supplies the default."
    },
    "maxLength": {
      "type": "integer",
      "minimum": 1,
      "description": "For string, the maximum UTF-8 bytes; for array, the maximum number of items."
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "knownValues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxLength": 64,
      "description": "For string: an open, advisory set of values."
    },
    "maxGraphemes": {
      "type": "integer",
      "minimum": 1,
      "description": "For string: the maximum graphemes."
    }
  },
  "description": "A parameter a binding site supplies. type is a Lexicon primitive or an NSID. The constraint fields work like Lexicon's and apply only where Lexicon applies them; using one on a type it does not govern makes the tile invalid."
}

Lexicon Garden

@