Git.Top Graph API

openapi: 3.2.0
info:
  title: Git.Top Agent Graph API
  version: 0.1.0
  description: Agent-native GitHub project knowledge API for search, project lookup, alternatives, comparison, graph reasoning, quality, and schema discovery. High-confidence clients should inspect metadata.source, metadata.reason, trust fields, classification evidence, quality_signal_confidence, verification signals, and migration validation steps, and use require_d1=true when seed fallback should fail closed.
servers:
- url: https://git.top
  description: Production
- url: http://localhost:8787
  description: Local Worker
tags:
- name: Graph
paths:
  /api/graph:
    get:
      summary: Return project relationship graph nodes, edges, stats, summary, next actions…
      parameters:
      - name: repo
        in: query
        required: false
        description: Optional focus repository or Git.Top product alias such as claude-code
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum project count
        schema:
          type: string
      - name: require_d1
        in: query
        required: false
        description: Fail closed unless D1-backed data is available
        schema:
          type: string
      responses:
        '200':
          description: Knowledge graph with graph_stats, summary, next_actions, migration_paths, alternatives, related projects, dependencies, deployment targets, and use cases when focused on a project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphResponse'
              example:
                focus: cloudflare/agents
                project:
                  repo: cloudflare/agents
                  name: agents
                  description: Build AI agents on Cloudflare.
                  maintainer: cloudflare
                  license: MIT
                  language: TypeScript
                  recent_activity: fresh
                summary: Focused graph for cloudflare/agents.
                graph_stats:
                  node_count: 4
                  edge_count: 3
                  relationship_counts:
                    related: 1
                    deployment: 1
                    category: 1
                relationship_groups:
                  alternatives:
                  - repo: langchain-ai/langgraph
                    reason: Agent workflow alternative.
                  related:
                  - repo: cloudflare/workers-sdk
                    reason: Shared deployment target.
                  dependencies:
                  - workers
                  deployment_targets:
                  - cloudflare
                  use_cases:
                  - stateful agents
                migration_paths:
                - from: cloudflare/agents
                  to: langchain-ai/langgraph
                  compatibility: medium
                  estimated_cost: medium
                  shared_signals:
                  - category:agent_framework
                  - use_case:stateful agents
                  gaps:
                  - Deployment targets and primary language require review.
                  validation_steps:
                  - Compare API, configuration, license, and dependency requirements.
                  - Run the target project's minimal example or test suite.
                  evidence:
                  - agent_card.category
                  - agent_card.deployment
                  - agent_card.use_cases
                  - project.language
                  - project.license
                nodes:
                - id: cloudflare/agents
                  label: agents
                  kind: project
                  repo: cloudflare/agents
                  score: 90
                - id: deployment:cloudflare
                  label: cloudflare
                  kind: deployment
                edges:
                - source: cloudflare/agents
                  target: deployment:cloudflare
                  kind: deployment
                  weight: 96
                evidence:
                  source_fields:
                  - agent_card.classification
                  - graph.nodes
                  - graph.edges
                  - graph.relationship_groups
                  - graph.migration_paths
                  - verification.signals
                  caveats: []
                  confidence_reason: cloudflare/agents graph is grounded in indexed alternatives, related projects, deployments, dependencies, and use cases.
                  verification:
                    schema_version: git-top.verification.v1
                    overall_status: partial
                    observed_at: '2026-07-04T00:00:00.000Z'
                    signals:
                      activity:
                        status: observed
                        source: github_metadata
                        evidence:
                        - project.pushed_at
                        - metrics.recent_push_days
                      license:
                        status: observed
                        source: github_metadata
                        evidence:
                        - project.license
                      documentation:
                        status: observed
                        source: github_metadata
                        evidence:
                        - project.description
                      runtime:
                        status: inferred
                        source: git_top_heuristic
                        evidence:
                        - agent_card.deployment
                        - agent_card.cloudflare_ready
                      install:
                        status: not_run
                        source: git_top_runtime
                        evidence:
                        - installation/build probe is not enabled
                      security:
                        status: not_run
                        source: git_top_runtime
                        evidence:
                        - dependency/security scan is not enabled
                      mcp:
                        status: not_applicable
                        source: git_top_runtime
                        evidence:
                        - project is not classified as mcp_server
                    coverage:
                      observed: 3
                      inferred: 1
                      not_run: 2
                      unknown: 0
                    next_steps:
                    - Run an installation/build probe before production adoption.
                    - Run a dependency and security scan before treating the score as a trust claim.
                  last_verified_at: '2026-07-04T00:00:00.000Z'
                caveats: []
                confidence_reason: cloudflare/agents graph is grounded in indexed alternatives, related projects, deployments, dependencies, and use cases.
                source_fields:
                - agent_card.classification
                - graph.nodes
                - graph.edges
                - graph.relationship_groups
                - graph.migration_paths
                - verification.signals
                last_verified_at: '2026-07-04T00:00:00.000Z'
                metadata:
                  source: d1
                  reason: d1_query
                  project_count: 500
                  generated_at: '2026-07-04T00:00:00.000Z'
                  snapshot_id: d1:500:2026-07-04T00:00:00.000Z
                  latest_synced_at: '2026-07-04T00:00:00.000Z'
                  schema_version: git-top.knowledge.v1
      tags:
      - Graph
      operationId: getApiGraph
      x-operation-id-source: derived
    post:
      summary: Return a project relationship graph from a structured JSON body
      parameters:
      - name: require_d1
        in: query
        required: false
        description: Fail closed unless D1-backed data is available
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GraphRequest'
      responses:
        '200':
          description: Knowledge graph with project context, graph_stats, summary, next_actions, relationship groups, and heuristic migration paths
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphResponse'
        '400':
          description: Invalid graph request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Graph
      operationId: postApiGraph
      x-operation-id-source: derived
  /api/graph/{owner}/{repo}:
    get:
      summary: Return project relationship graph nodes, edges, stats, summary, next actions…
      parameters:
      - name: owner
        in: path
        required: true
        description: GitHub owner or single-segment project alias when using /api/graph/{project}
        schema:
          type: string
      - name: repo
        in: path
        required: true
        description: GitHub repository name
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum project count
        schema:
          type: string
      - name: require_d1
        in: query
        required: false
        description: Fail closed unless D1-backed data is available
        schema:
          type: string
      responses:
        '200':
          description: Focused project knowledge graph with graph_stats, summary, next_actions, grouped alternatives, heuristic migration paths, related projects, dependencies, deployment targets, and use cases
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphResponse'
      tags:
      - Graph
      operationId: getApiGraphByOwnerByRepo
      x-operation-id-source: derived
  /api/graph/{project}:
    get:
      summary: Return a focused project relationship graph by short slug, encoded owner/repo…
      parameters:
      - name: project
        in: path
        required: true
        description: Project slug, encoded owner/repo id, or product alias such as claude-code
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum project count
        schema:
          type: string
      - name: require_d1
        in: query
        required: false
        description: Fail closed unless D1-backed data is available
        schema:
          type: string
      responses:
        '200':
          description: Focused project knowledge graph with resolved_from, graph_stats, summary, next_actions, grouped alternatives, heuristic migration paths, related projects, dependencies, deployment targets, and use cases
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphResponse'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Graph
      operationId: getApiGraphByProject
      x-operation-id-source: derived
components:
  schemas:
    NormalizedEvidence:
      type: object
      description: Normalized evidence package for agent citation and caveat handling.
      properties:
        classification:
          type: object
          additionalProperties: true
        quality_signal_confidence:
          $ref: '#/components/schemas/QualitySignalConfidence'
        verification:
          oneOf:
          - $ref: '#/components/schemas/VerificationPackage'
          - type: 'null'
        source_fields:
          type: array
          items:
            type: string
        caveats:
          type: array
          items:
            type: string
        confidence_reason:
          type: string
        last_verified_at:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: true
    NextAction:
      type: object
      properties:
        label:
          type: string
        href:
          type: string
        kind:
          type: string
      additionalProperties: true
    GraphResponse:
      type: object
      required:
      - nodes
      - edges
      - graph_stats
      - metadata
      properties:
        focus:
          type: string
        resolved_from:
          type: object
          additionalProperties: true
        project:
          $ref: '#/components/schemas/GraphProjectContext'
        summary:
          type: string
        graph_stats:
          type: object
          additionalProperties: true
        next_actions:
          type: array
          items:
            $ref: '#/components/schemas/NextAction'
        relationship_groups:
          type: object
          additionalProperties: true
        migration_paths:
          type: array
          items:
            $ref: '#/components/schemas/MigrationPath'
        nodes:
          type: array
          items:
            $ref: '#/components/schemas/GraphNode'
        edges:
          type: array
          items:
            $ref: '#/components/schemas/GraphEdge'
        evidence:
          $ref: '#/components/schemas/NormalizedEvidence'
        caveats:
          type: array
          items:
            type: string
        confidence_reason:
          type: string
        source_fields:
          type: array
          items:
            type: string
        last_verified_at:
          type:
          - string
          - 'null'
          format: date-time
        metadata:
          $ref: '#/components/schemas/Metadata'
      additionalProperties: true
    QualitySignalConfidence:
      type: object
      description: Completeness hints for GitHub-derived score inputs. Agents should avoid overclaiming partial or unknown signals.
      properties:
        stars_30d_delta:
          type: string
          enum:
          - snapshot
          - estimated
        stars_30d_window_days:
          type: integer
        commits_30d:
          type: string
          enum:
          - complete
          - partial
          - unknown
        releases_180d:
          type: string
          enum:
          - complete
          - partial
          - unknown
        contributors_90d:
          type: string
          enum:
          - complete
          - partial
          - unknown
      additionalProperties: true
    VerificationSignal:
      type: object
      description: One project verification signal. observed and inferred are indexed evidence; not_run means the independent probe has not been executed.
      required:
      - status
      - source
      - evidence
      properties:
        status:
          type: string
          enum:
          - verified
          - observed
          - inferred
          - not_run
          - not_applicable
          - unknown
        source:
          type: string
          enum:
          - github_metadata
          - git_top_heuristic
          - git_top_runtime
        evidence:
          type: array
          items:
            type: string
      additionalProperties: false
    GraphEdge:
      type: object
      required:
      - source
      - target
      - kind
      - weight
      properties:
        source:
          type: string
        target:
          type: string
        kind:
          type: string
          enum:
          - alternative
          - related
          - category
          - deployment
          - use_case
          - dependency
        reason:
          type: string
        weight:
          type: number
      additionalProperties: true
    VerificationPackage:
      type: object
      description: Structured verification coverage for project selection. It does not claim install, security, runtime, or MCP execution unless a signal is verified.
      required:
      - schema_version
      - overall_status
      - observed_at
      - signals
      - coverage
      - next_steps
      properties:
        schema_version:
          type: string
          const: git-top.verification.v1
        overall_status:
          type: string
          enum:
          - complete
          - partial
          - unverified
        observed_at:
          type:
          - string
          - 'null'
          format: date-time
        signals:
          type: object
          required:
          - activity
          - license
          - documentation
          - runtime
          - install
          - security
          - mcp
          properties:
            activity:
              $ref: '#/components/schemas/VerificationSignal'
            license:
              $ref: '#/components/schemas/VerificationSignal'
            documentation:
              $ref: '#/components/schemas/VerificationSignal'
            runtime:
              $ref: '#/components/schemas/VerificationSignal'
            install:
              $ref: '#/components/schemas/VerificationSignal'
            security:
              $ref: '#/components/schemas/VerificationSignal'
            mcp:
              $ref: '#/components/schemas/VerificationSignal'
          additionalProperties: false
        coverage:
          type: object
          required:
          - observed
          - inferred
          - not_run
          - unknown
          properties:
            observed:
              type: integer
              minimum: 0
            inferred:
              type: integer
              minimum: 0
            not_run:
              type: integer
              minimum: 0
            unknown:
              type: integer
              minimum: 0
          additionalProperties: false
        next_steps:
          type: array
          items:
            type: string
      additionalProperties: false
    ErrorResponse:
      type: object
      description: Common API error envelope.
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine-readable error code when available, such as d1_required.
        message:
          type: string
        metadata:
          $ref: '#/components/schemas/Metadata'
    GraphRequest:
      type: object
      properties:
        project_id:
          type: string
        projectId:
          type: string
        repo:
          type: string
        focus:
          type: string
        limit:
          type: integer
    GraphProjectContext:
      type: object
      properties:
        repo:
          type: string
        name:
          type: string
        description:
          type: string
        maintainer:
          type: string
        license:
          type:
          - string
          - 'null'
        language:
          type:
          - string
          - 'null'
        recent_activity:
          type: string
      additionalProperties: true
    GraphNode:
      type: object
      required:
      - id
      - label
      - kind
      properties:
        id:
          type: string
        label:
          type: string
        kind:
          type: string
          enum:
          - project
          - category
          - deployment
          - use_case
          - dependency
        score:
          type: number
        repo:
          type: string
      additionalProperties: true
    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.
    MigrationPath:
      type: object
      description: Heuristic migration decision aid. It is not a drop-in compatibility or production readiness guarantee.
      required:
      - from
      - to
      - compatibility
      - estimated_cost
      - shared_signals
      - gaps
      - validation_steps
      - evidence
      properties:
        from:
          type: string
        to:
          type: string
        compatibility:
          type: string
          enum:
          - high
          - medium
          - low
          - unknown
        estimated_cost:
          type: string
          enum:
          - low
          - medium
          - high
          - unknown
        shared_signals:
          type: array
          items:
            type: string
        gaps:
          type: array
          items:
            type: string
        validation_steps:
          type: array
          items:
            type: string
        evidence:
          type: array
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    syncSecret:
      type: http
      scheme: bearer
      description: Admin endpoints require the SYNC_SECRET bearer token.
    feedbackSecret:
      type: http
      scheme: bearer
      description: Optional FEEDBACK_SECRET. Without it, proposals are validated and fingerprinted but not persisted.