{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/open-government-austria/json-schema/open-government-austria-query-schema.json",
  "title": "Query",
  "description": "Query",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/open-government-austria-hub-search-openapi.yml#/components/schemas/Query",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "description": "The query"
    },
    "filter": {
      "type": "string",
      "description": "Filter queries by document type"
    },
    "facets": {
      "type": "object",
      "description": "Filter queries by facets (string as json, e.g. 'facets={\"catalog\":[\"catalog-x\"]}')",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "page": {
      "type": "integer",
      "minimum": 0,
      "description": "The page number of matching results"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of matching datasets per page",
      "minimum": 0,
      "maximum": 1000
    },
    "fields": {
      "type": "array",
      "description": "Filter queries by document fields (e.g. 'fields=title')",
      "items": {
        "type": "string"
      }
    },
    "searchParams": {
      "type": "object",
      "properties": {
        "minDate": {
          "type": "string",
          "description": "Filter queries by minimum Date",
          "format": "date-time"
        },
        "maxDate": {
          "type": "string",
          "description": "Filter queries by maximum Date",
          "format": "date-time"
        },
        "boundingBox": {
          "$ref": "#/$defs/BoundingBox"
        },
        "scoring": {
          "type": "object",
          "properties": {
            "min": {
              "type": "integer"
            },
            "max": {
              "type": "integer"
            }
          }
        }
      }
    },
    "boost": {
      "type": "object",
      "description": "Boost document fields",
      "additionalProperties": {
        "type": "number",
        "description": "Use field or field.subfield",
        "format": "float"
      }
    },
    "globalAggregation": {
      "type": "boolean",
      "description": "Counting of facets globally or locally (default true)"
    },
    "facetOperator": {
      "type": "string",
      "description": "Filtering queries by facets are combined with \"AND\" or \"OR\" (default \"OR\")",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "facetGroupOperator": {
      "type": "string",
      "description": "Filtering queries by facetgroups are combined with \"AND\" or \"OR\" (default \"AND\")",
      "enum": [
        "AND",
        "OR"
      ]
    },
    "sort": {
      "type": "array",
      "description": "Sorting of the search result (usage \"field+asc\" or \"field+desc\", default is desc)",
      "items": {
        "type": "string"
      }
    },
    "filterDistributions": {
      "type": "boolean",
      "description": "If datasets are searched by facets distributions are returned filtered (default false)"
    },
    "aggregation": {
      "type": "boolean",
      "description": "Enables aggregation of facets (default true)"
    },
    "includes": {
      "type": "array",
      "description": "Descides which fields are included in the response (default all)",
      "items": {
        "type": "string"
      }
    },
    "scroll": {
      "type": "boolean",
      "description": "Enables scroll and returns a scroll id (default true)"
    },
    "minScoring": {
      "type": "integer",
      "description": "Filter by minimum quality measurement scoring value"
    },
    "maxScoring": {
      "type": "integer",
      "description": "Filter by maximum quality measurement scoring value"
    },
    "aggregationAllFields": {
      "type": "boolean",
      "description": "Aggregate all facets (default true)"
    },
    "aggregationFields": {
      "type": "array",
      "description": "Aggregate selected facets (ignored if aggregationAllFields is set true)",
      "items": {
        "type": "string"
      }
    },
    "countryData": {
      "type": "boolean",
      "description": "If enabled only datasets from country catalogues are returned. If disabled only datasets from non-country catalogues are returned. If not specified (null), no filtering is performed."
    }
  },
  "$defs": {
    "BoundingBox": {
      "type": "object",
      "description": "Filter queries by bounding box",
      "properties": {
        "minLon": {
          "type": "number",
          "description": "Minimum longitude",
          "format": "float",
          "minimum": -180,
          "maximum": 180
        },
        "maxLon": {
          "type": "number",
          "description": "Maximum longitude",
          "format": "float",
          "minimum": -180,
          "maximum": 180
        },
        "maxLat": {
          "type": "number",
          "description": "Maximum latitude",
          "format": "float",
          "minimum": -90,
          "maximum": 90
        },
        "minLat": {
          "type": "number",
          "description": "Minimum latitude",
          "format": "float",
          "minimum": -90,
          "maximum": 90
        }
      }
    }
  }
}