BenchmarkResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/git-top/json-schema/git-top-benchmark-response-schema.json",
  "title": "BenchmarkResponse",
  "description": "Public benchmark summary for agents and users evaluating Git.Top recommendation health and trust limits.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/git-top-openapi.json#/components/schemas/BenchmarkResponse",
  "type": "object",
  "required": [
    "name",
    "evaluation",
    "explanations",
    "data_coverage",
    "review_queue",
    "known_limitations",
    "metadata"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "positioning": {
      "type": "string"
    },
    "summary": {
      "type": "string"
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    },
    "evaluation": {
      "type": "object",
      "properties": {
        "top1_hit_rate": {
          "type": "number"
        },
        "top3_hit_rate": {
          "type": "number"
        },
        "category_accuracy": {
          "type": "number"
        },
        "deployment_accuracy": {
          "type": "number"
        },
        "cloudflare_readiness_accuracy": {
          "type": "number"
        },
        "unacceptable_hit_count": {
          "type": "integer"
        },
        "review_focus": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "source_report": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "explanations": {
      "type": "object",
      "properties": {
        "checks": {
          "type": "integer"
        },
        "passed": {
          "type": "integer"
        },
        "failed": {
          "type": "integer"
        },
        "coverage": {
          "type": "number"
        },
        "source_report": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "data_coverage": {
      "type": "object",
      "additionalProperties": true
    },
    "review_queue": {
      "type": "object",
      "additionalProperties": true
    },
    "known_limitations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recommended_use": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "metadata": {
      "$ref": "#/$defs/Metadata"
    }
  },
  "additionalProperties": true,
  "$defs": {
    "Metadata": {
      "type": "object",
      "description": "Common provenance envelope for agent-facing responses. Agents should require source=d1 for high-confidence production claims and disclose seed fallback.",
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "d1",
            "seed"
          ]
        },
        "reason": {
          "type": "string"
        },
        "project_count": {
          "type": "integer"
        },
        "generated_at": {
          "type": "string",
          "format": "date-time"
        },
        "snapshot_id": {
          "type": "string",
          "description": "Stable identity for the corpus snapshot used by this response."
        },
        "latest_synced_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "schema_version": {
          "type": "string",
          "enum": [
            "git-top.knowledge.v1"
          ]
        },
        "loaded_project_limit": {
          "type": "integer",
          "description": "Maximum D1 knowledge or search-candidate rows loaded into the bounded ranking set when present."
        },
        "truncated": {
          "type": "boolean",
          "description": "Whether the D1-backed ranking or candidate set reached its limit and may omit additional matching rows."
        },
        "candidate_retrieval": {
          "type": "string",
          "enum": [
            "d1_first"
          ],
          "description": "Search-only marker indicating that deterministic filters and broad query matching ran in D1 before TypeScript ranking."
        },
        "candidate_count": {
          "type": "integer",
          "description": "Number of D1 search candidates passed to the authoritative TypeScript filter and ranking stage."
        },
        "candidate_limit": {
          "type": "integer",
          "description": "Maximum number of D1 search candidates passed to the ranking stage."
        },
        "warnings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Fallback, count, freshness, or trust caveats that agents should account for before citing results."
        }
      }
    }
  }
}