Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Itemdeck Schema Documentation

JSON Schema specifications for defining itemdeck collections using the Entity-Relationship model.

Schema Versions

Version Status Description
v1 Current Entity-Relationship schema with typed fields and relationships

Quick Start

Create a collection by defining a collection.json:

{
  "$schema": "https://itemdeck.app/schemas/v1/collection.json",
  "id": "my-collection",
  "name": "My Collection",
  "entityTypes": {
    "item": {
      "primary": true,
      "fields": {
        "title": { "type": "string", "required": true },
        "year": { "type": "number" }
      }
    }
  }
}

Examples

Related Documentation