Git.Top Related API

openapi: 3.2.0
info:
  title: Git.Top Agent Related 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: Related
paths:
  /api/related/{owner}/{repo}:
    get:
      summary: Find related ecosystem projects connected by category, deployment, dependency…
      parameters:
      - name: owner
        in: path
        required: true
        description: GitHub owner
        schema:
          type: string
      - name: repo
        in: path
        required: true
        description: GitHub repository name
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum result 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: Related project list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedResponse'
      tags:
      - Related
      operationId: getApiRelatedByOwnerByRepo
      x-operation-id-source: derived
  /api/related/{project}:
    get:
      summary: Find related ecosystem projects by short slug, encoded owner/repo, or Git.Top…
      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 result 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: Related project list with project context, resolved_from, and metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedResponse'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Related
      operationId: getApiRelatedByProject
      x-operation-id-source: derived
  /api/related:
    post:
      summary: Find related ecosystem projects 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/RelatedRequest'
      responses:
        '200':
          description: Related project list with project context and metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedResponse'
        '400':
          description: Invalid related projects request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Project not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Related
      operationId: postApiRelated
      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
    RelatedRequest:
      type: object
      required:
      - project_id
      properties:
        project_id:
          type: string
        projectId:
          type: string
        repo:
          type: string
        limit:
          type: integer
    RelatedResponse:
      type: object
      required:
      - related
      - metadata
      properties:
        project:
          $ref: '#/components/schemas/ProjectCard'
        resolved_from:
          type: object
          additionalProperties: true
        related:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/ProjectCard'
            - type: object
              properties:
                reason:
                  type: string
              additionalProperties: true
        metadata:
          $ref: '#/components/schemas/Metadata'
      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
    ProjectSummary:
      type: object
      required:
      - tl_dr
      - purpose
      - inputs
      - outputs
      - good_for
      - not_good_for
      - deployment
      - alternatives
      properties:
        tl_dr:
          type: string
          description: One-sentence project overview for agents.
        purpose:
          type: string
          description: Longer agent-facing project purpose.
        install:
          type:
          - string
          - 'null'
          description: Conservative install or setup hint when Git.Top can infer one.
        inputs:
          type: array
          items:
            type: string
        outputs:
          type: array
          items:
            type: string
        good_for:
          type: array
          items:
            type: string
        not_good_for:
          type: array
          items:
            type: string
        deployment:
          type: array
          items:
            type: string
        alternatives:
          type: array
          items:
            type: object
            required:
            - repo
            - reason
            properties:
              repo:
                type: string
              reason:
                type: string
    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
    ProjectCard:
      type: object
      description: Compact project card used in search, recommendations, comparison, alternatives, and related project lists.
      required:
      - project_id
      - repo
      - name
      properties:
        project_id:
          type: string
        repo:
          type: string
        name:
          type: string
        github_url:
          type: string
        homepage_url:
          type:
          - string
          - 'null'
        language:
          type:
          - string
          - 'null'
        license:
          type:
          - string
          - 'null'
        project_kind:
          type: string
          enum:
          - project
          - collection
        collection_metadata:
          type: object
          additionalProperties: true
        category:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        description:
          type: string
        overview:
          type: string
        deployments:
          type: array
          items:
            type: string
        difficulty:
          type: string
        cloudflare_ready:
          type: boolean
        git_top_score:
          type: number
        quality_score:
          type: number
        agent_score:
          type: number
        score:
          type: number
        classification:
          type: object
          additionalProperties: true
        quality_signal_confidence:
          $ref: '#/components/schemas/QualitySignalConfidence'
        verification:
          $ref: '#/components/schemas/VerificationPackage'
        summary:
          $ref: '#/components/schemas/ProjectSummary'
        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
      additionalProperties: true
    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'
    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
    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.
  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.