Common manual schema

manual.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "child_section_groups"
  ],
  "properties": {
    "body": {
      "type": "string",
      "description": "This is only required by Specialist Publisher"
    },
    "child_section_groups": {
      "type": "array",
      "description": "This is based on the Specialist Publisher structure",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "child_sections"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "child_sections": {
            "type": "array",
            "items": {
              "required": [
                "section_id",
                "title",
                "description",
                "base_path"
              ],
              "additionalProperties": false,
              "type": "object",
              "properties": {
                "section_id": {
                  "type": "string",
                  "description": "HMRC manuals specific"
                },
                "title": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "base_path": {
                  "$ref": "#/definitions/absolute_path"
                }
              }
            }
          }
        }
      }
    },
    "change_history": {
      "$ref": "#/definitions/change_history",
      "description": "Service manual uses the common schemas definition, we should migrate other manuals to this."
    },
    "organisations": {
      "type": "array",
      "description": "Specific to HMRC and Specialist Publisher manuals.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "title",
          "abbreviation",
          "web_url"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "abbreviation": {
            "type": "string"
          },
          "web_url": {
            "type": "string"
          }
        }
      }
    },
    "tags": {
      "type": "object",
      "description": "Specific to HMRC manuals",
      "additionalProperties": false,
      "properties": {
        "topics": {
          "description": "Slugs of the Manual's topics. An example of a topic slug is 'business-tax/vat'.",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}