Common manual section schema

manual_section.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "manual"
  ],
  "properties": {
    "section_id": {
      "type": "string",
      "description": "Specific to HMRC manuals",
    },
    "visually_collapsed": {
      "type": "boolean",
      "description": "Service Manual specific"
    },
    "show_description": {
      "type": "boolean",
      "description": "Service Manual specific. This is needed for the service standard points."
    },
    "breadcrumbs": {
      "type": "array",
      "description": "HMRC specific. This could possibly be removed if dependency resolution can provide these.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "base_path",
          "section_id"
        ],
        "properties": {
          "base_path": {
            "$ref": "#/definitions/absolute_path"
          },
          "section_id": {
            "type": "string"
          }
        }
      }
    },
    "header_links": {
      "type": "array",
      "description": "Service Manual specific",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "href": {
            "$ref": "#/definitions/anchor_href"
          }
        },
        "required": [
          "title",
          "href"
        ]
      }
    },
    "body": {
      "type": "string"
    },
    "manual": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "base_path"
      ],
      "properties": {
        "base_path": {
          "$ref": "#/definitions/absolute_path"
        }
      }
    },
    "organisations": {
      "type": "array",
      "description": "Specific to Specialist Publisher and HMRC manuals",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "title",
          "abbreviation",
          "web_url"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "abbreviation": {
            "type": "string"
          },
          "web_url": {
            "type": "string"
          }
        }
      }
    },
    "child_section_groups": {
      "type": "array",
      "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"
                },
                "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."
    }
  }
}