SearchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/influence-so/json-schema/influence-so-search-response-schema.json",
  "title": "SearchResponse",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/influence-so-openapi.json#/components/schemas/SearchResponse",
  "properties": {
    "count": {
      "type": "integer"
    },
    "query": {
      "type": "string"
    },
    "results": {
      "items": {
        "$ref": "#/$defs/SearchHit"
      },
      "type": "array"
    }
  },
  "required": [
    "count",
    "query",
    "results"
  ],
  "type": "object",
  "$defs": {
    "SearchHit": {
      "properties": {
        "contentType": {
          "type": "string"
        },
        "excerpt": {
          "description": "The page description, else the start of its content.",
          "type": "string"
        },
        "facets": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Facet values the site declares for the page's content type (`content.types.<type>.facets`), key → value.",
          "type": "object"
        },
        "route": {
          "description": "The page's route; pass it to `getPage`.",
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "url": {
          "format": "uri-reference",
          "type": "string"
        },
        "version": {
          "description": "Docs version the page belongs to on a versioned site: `\"\"` for the current docs, else an archived version id. Absent on unversioned sites.",
          "type": "string"
        }
      },
      "required": [
        "excerpt",
        "route",
        "title",
        "url"
      ],
      "type": "object"
    }
  }
}