common-facet.json

{
  "title": "facet",
  "description": "A single facet for a specific filter. Every facet has a human-readable name and total count to show to end-users to drill down search results.",
  "type": "object",
  "properties": {
    "name": {
      "$ref": "./common-name.json"
    },
    "count": {
      "type": "integer",
      "description": "Total results if the filter is applied with this value (= the key referencing this object)."
    },
    "children": {
      "type": "object",
      "description": "Children facets, in the case of filters with a hierarchy.",
      "additionalProperties": {
        "$ref": "./common-facet.json"
      }
    }
  },
  "required": [
    "name",
    "count"
  ],
  "examples": [
    {
      "name": {
        "nl": "Vlaams-Brabant",
        "fr": "Brabant Flamand",
        "en": "Flemish Brabant"
      },
      "count": 22,
      "children": {
        "gem-leuven": {
          "name": {
            "nl": "Leuven",
            "fr": "Louvain"
          },
          "count": 17
        },
        "gem-diest": {
          "name": {
            "nl": "Diest",
            "fr": "Diest"
          },
          "count": 5
        }
      }
    }
  ]
}