@stencila/schema/dist/List.schema.json

Stencila schema and other specifications

{
  "title": "List",
  "@id": "schema:ItemList",
  "extends": "Entity",
  "role": "secondary",
  "status": "unstable",
  "category": "prose",
  "description": "A list of items.\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "List"
      ],
      "default": "List",
      "from": "Entity"
    },
    "id": {
      "@id": "schema:id",
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Entity"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Entity"
    },
    "items": {
      "@id": "schema:itemListElement",
      "description": "The items in the list",
      "type": "array",
      "items": {
        "$ref": "ListItem.schema.json"
      },
      "from": "List",
      "aliases": [
        "item"
      ]
    },
    "order": {
      "@id": "schema:itemListOrder",
      "description": "Type of ordering.",
      "enum": [
        "ascending",
        "descending",
        "unordered"
      ],
      "default": "unordered",
      "from": "List"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "file": "List.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v0/List.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/List.schema.yaml",
  "type": "object",
  "propertyAliases": {
    "item": "items"
  },
  "additionalProperties": false
}