hydesearch/tests/schema.json

Experimental Frontend Search Engine for Hyde Documentation Sites

{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "https://cdn.desilva.se/storage/permanent/2022/schemas/hydesearch/schema-draft.json",
  "type": "array",
  "default": [],
  "title": "HydeSearchIndex Schema",
  "items": {
    "type": "object",
    "title": "Page Object",
    "required": [
      "slug",
      "title",
      "content",
      "destination"
    ],
    "properties": {
      "slug": {
        "type": "string",
        "title": "The page slug",
        "examples": [
          "down-the-rabbithole"
        ]
      },
      "title": {
        "type": "string",
        "title": "The page title",
        "examples": [
          "Down the Rabbit-Hole"
        ]
      },
      "content": {
        "type": "string",
        "title": "The searchable contents",
        "examples": [
          "CHAPTER I\n\n Down the Rabbit-Hole\n\n Alice was beginning to get very tired [...]"
        ]
      },
      "destination": {
        "type": "string",
        "title": "The location of the page",
        "examples": [
          "down-the-rabbithole.html"
        ]
      }
    }
  }
}