{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/zincsearch/json-schema/zincsearch-v1-zinc-query-for-sdk-schema.json",
  "title": "v1.ZincQueryForSDK",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/zincsearch-search-api-openapi.yml#/components/schemas/v1.ZincQueryForSDK",
  "type": "object",
  "properties": {
    "_source": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "aggs": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/v1.AggregationParams"
      }
    },
    "explain": {
      "type": "boolean"
    },
    "from": {
      "type": "integer"
    },
    "highlight": {
      "$ref": "#/$defs/meta.Highlight"
    },
    "max_results": {
      "type": "integer"
    },
    "query": {
      "$ref": "#/$defs/v1.QueryParams"
    },
    "search_type": {
      "description": "SearchType is the type of search to perform. Can be match, match_phrase, query_string, etc",
      "type": "string"
    },
    "sort_fields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$defs": {
    "meta.Highlight": {
      "type": "object",
      "properties": {
        "fields": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/meta.Highlight"
          }
        },
        "fragment_size": {
          "type": "integer"
        },
        "number_of_fragments": {
          "type": "integer"
        },
        "post_tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "pre_tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1.AggregationDateRange": {
      "type": "object",
      "properties": {
        "from": {
          "type": "string"
        },
        "to": {
          "type": "string"
        }
      }
    },
    "v1.AggregationNumberRange": {
      "type": "object",
      "properties": {
        "from": {
          "type": "number"
        },
        "to": {
          "type": "number"
        }
      }
    },
    "v1.AggregationParams": {
      "type": "object",
      "properties": {
        "agg_type": {
          "type": "string"
        },
        "aggs": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/v1.AggregationParams"
          }
        },
        "date_ranges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/v1.AggregationDateRange"
          }
        },
        "field": {
          "type": "string"
        },
        "ranges": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/v1.AggregationNumberRange"
          }
        },
        "size": {
          "type": "integer"
        },
        "weight_field": {
          "description": "Field name to be used for setting weight for primary field for weighted average aggregation",
          "type": "string"
        }
      }
    },
    "v1.QueryParams": {
      "type": "object",
      "properties": {
        "boost": {
          "type": "integer"
        },
        "end_time": {
          "type": "string"
        },
        "field": {
          "type": "string"
        },
        "start_time": {
          "type": "string"
        },
        "term": {
          "type": "string"
        },
        "terms": {
          "description": "For multi phrase query",
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}