product_info.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Product Info",
  "description": "Schema for product info.json files",
  "type": "object",
  "properties": {
    "vendor_id": {
      "type": "string",
      "description": "The vendor ID. This is present in database dumps, but not in the database structure that humans maintain in github"
    },
    "name": {
      "type": "string",
      "description": "The name of the product, as it appears in the product's marketing materials.",
      "minLength": 1
    },
    "blurb": {
      "type": "string",
      "description": "A 1-3 sentence description of the product.",
      "minLength": 10,
      "maxLength": 1000
    },
    "line_art_svg": {
      "type": "string",
      "description": "An SVG line art image of the product.",
      "pattern": "^.*\\.(svg)$",
      "minLength": 5
    },
    "line_art_96x64_png": {
      "type": "string",
      "description": "A 96x64 PNG version of the SVG line art (auto-generated by CI/CD script, do not upload)",
      "pattern": "^.*\\.(png)$",
      "minLength": 5
    },
    "type": {
      "type": "string",
      "description": "The type of product.",
      "enum": ["headphones"],
      "default": "headphones"
    },
    "subtype": {
      "type": "string",
      "description": "The subtype of the headphones.",
      "enum": ["over_the_ear", "on_ear", "in_ear", "earbuds" ]
    }
  },
  "required": ["name", "type", "subtype" ],
  "additionalProperties": false
}