ing.dasl.masl

robin.berjon.com

Documentation

A tile, instantiating MASL metadata into a record

main record

A tile, instantiating MASL metadata into a record

Record Key tid Timestamp-based ID

Properties

cid string cid Required

The DRISL CID of the MASL for the tile

createdAt string datetime Required

Timestamp

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "cid",
      "tile",
      "createdAt"
    ],
    "properties": {
      "cid": {
        "type": "string",
        "format": "cid",
        "description": "The DRISL CID of the MASL for the tile"
      },
      "tile": {
        "ref": "ing.dasl.masl#masl",
        "type": "ref",
        "description": "The MASL content"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp"
      }
    }
  },
  "description": "A tile, instantiating MASL metadata into a record"
}
masl object

MASL metadata as defined in https://dasl.ing/masl.html

Properties

background_color string Optional

A colour for the background of the tile

categories array of string Optional

Tags categorising the tile

description string Optional

Short overview of the content

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
icons array of object Optional

Icons for the tile

name string Required

The name for the tile, can be a title or app name

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
prev cid-link Optional

In case there are multiple versions of this tile, this is the CID of the previous one

resources unknown Required

A mapping of path to object with a CID src and HTTP headers

roots array of cid-link Optional

The CAR roots — avoid using this

screenshots array of object Optional

Screenshots, can be used for banner or card images

short_name string Optional

A name, in case the basic name cannot fit

sizing object Optional

Requesting sizing properties for the content

theme_color string Optional

Theme colour

version integer Optional

The CAR version — avoid using this

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "resources"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 1000,
      "description": "The name for the tile, can be a title or app name",
      "maxGraphemes": 100
    },
    "prev": {
      "type": "cid-link",
      "description": "In case there are multiple versions of this tile, this is the CID of the previous one"
    },
    "icons": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "src"
        ],
        "properties": {
          "src": {
            "type": "string"
          },
          "sizes": {
            "type": "string"
          },
          "purpose": {
            "type": "string"
          }
        }
      },
      "description": "Icons for the tile"
    },
    "roots": {
      "type": "array",
      "items": {
        "type": "cid-link"
      },
      "description": "The CAR roots — avoid using this"
    },
    "sizing": {
      "type": "object",
      "required": [
        "width",
        "height"
      ],
      "properties": {
        "width": {
          "type": "integer",
          "mininum": 1
        },
        "height": {
          "type": "integer",
          "mininum": 1
        }
      },
      "description": "Requesting sizing properties for the content"
    },
    "version": {
      "type": "integer",
      "const": 1,
      "description": "The CAR version — avoid using this"
    },
    "resources": {
      "type": "unknown",
      "description": "A mapping of path to object with a CID src and HTTP headers"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags categorising the tile"
    },
    "short_name": {
      "type": "string",
      "description": "A name, in case the basic name cannot fit"
    },
    "description": {
      "type": "string",
      "maxLength": 3000,
      "description": "Short overview of the content",
      "maxGraphemes": 300
    },
    "screenshots": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "src"
        ],
        "properties": {
          "src": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "sizes": {
            "type": "string"
          }
        }
      },
      "description": "Screenshots, can be used for banner or card images"
    },
    "theme_color": {
      "type": "string",
      "description": "Theme colour"
    },
    "background_color": {
      "type": "string",
      "description": "A colour for the background of the tile"
    }
  },
  "description": "MASL metadata as defined in https://dasl.ing/masl.html"
}

Lexicon Garden

@