gallery.json

{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/gallery.json",
  "type": "object",
  "description": "Workbook template gallery schema",
  "required": [
    "$schema",
    "categories",
    "version"
  ],
  "properties": {
    "$schema": {
      "$id": "#/$schema",
      "type": "string",
      "default": "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/gallery.json"
    },
    "version": {
      "$id": "#/properties/version",
      "type": "string",
      "description": "Gallery version",
      "default": "TemplateGallery/1.0"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$id": "#/categories/id",
            "type": "string",
            "description": "ID for the category"
          },
          "name": {
            "$id": "#/categories/name",
            "type": "string",
            "description": "Name for the category. This field will be localized"
          },
          "templates": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "$id": "#/categories/templates/id",
                    "type": "string",
                    "description": "The folder where the template resides relative to the root repository",
                    "examples": [
                      "Workbooks/Performance/Apdex"
                    ]
                  },
                  "author": {
                    "$id": "#/categories/templates/author",
                    "type": "string",
                    "description": "Author of the template",
                    "examples": [
                      "Microsoft"
                    ]
                  },
                  "name": {
                    "$id": "#/categories/templates/name",
                    "type": "string",
                    "description": "Name for the template. This field will be localized"
                  },
                  "description": {
                    "$id": "#/categories/templates/description",
                    "type": "string",
                    "description": "Description for the template. This field will be localized"
                  },
                  "isPreview": {
                    "$id": "#/categories/templates/ispreview",
                    "type": "boolean",
                    "description": "Optional flag to mark the template as preview"
                  },
                  "tags": {
                    "$id": "#/categories/templates/tags",
                    "type": "array",
                    "description": "Optional list of tags that describes the template",
                    "items": [
                      {
                        "type": "string"
                      }
                    ]
                  }
                },
                "required": [
                  "id",
                  "author",
                  "name"
                ]
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "templates"
        ]
      }
    }
  }
}