Terms

  • Blueprint — A collection of sheets that describe a complete dataset
  • Sheet — A collection of fields that describe a single entity (eg. people, products, companies)
  • Field — Describes an attribute of the entity (eg. name, email) and how it should behave
{
  "sheets": [
    {
      "name": "Products",
      "description": "A list of products available for sale",
      "slug": "products",
      "readOnly": false,
      "allowAdditionalFields": false,
      "access": ["add", "edit"],
      "fields": [
        {
          "key": "code",
          "label": "Product Code",
          "type": "string"
        },
        {
          "key": "description",
          "type": "string"
        },
        {
          "key": "price",
          "type": "number"
        }
      ],
      "actions": [],
      "metadata": {}
    }
  ]
}