DocSearchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/secure-flows-com/json-schema/secure-flows-com-doc-search-response-schema.json",
  "title": "DocSearchResponse",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/secure-flows-docs-api.yaml#/components/schemas/DocSearchResponse",
  "type": "object",
  "required": [
    "query",
    "embedModel",
    "limit",
    "hits"
  ],
  "properties": {
    "query": {
      "type": "string"
    },
    "embedModel": {
      "type": "string"
    },
    "limit": {
      "type": "integer"
    },
    "hits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DocSearchHit"
      }
    }
  },
  "$defs": {
    "DocSearchHit": {
      "type": "object",
      "required": [
        "sourcePath",
        "sourceType",
        "title",
        "heading",
        "snippet",
        "url",
        "score"
      ],
      "properties": {
        "sourcePath": {
          "type": "string",
          "description": "Repository-relative path of the indexed source file"
        },
        "sourceType": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "heading": {
          "type": "string",
          "description": "Nearest section heading when chunked from Markdown"
        },
        "snippet": {
          "type": "string",
          "description": "Short excerpt from the chunk"
        },
        "url": {
          "type": "string",
          "format": "uri-reference",
          "description": "Public URL to read the full document"
        },
        "score": {
          "type": "number",
          "format": "double",
          "description": "Similarity score (higher is better)"
        }
      }
    }
  }
}