Git.Top Feedback API

openapi: 3.2.0
info:
  title: Git.Top Agent Feedback 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: Feedback
paths:
  /api/feedback/proposals:
    post:
      summary: Validate a structured agent correction proposal; persist only with…
      security:
      - {}
      - feedbackSecret: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackProposalRequest'
      responses:
        '200':
          description: Validated proposal that was not persisted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackProposalResponse'
        '202':
          description: Authenticated proposal persisted for review
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackProposalResponse'
        '400':
          description: Invalid proposal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid feedback authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Feedback
      operationId: postApiFeedbackProposals
      x-operation-id-source: derived
components:
  schemas:
    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.
    FeedbackProposalResponse:
      type: object
      required:
      - proposal
      - persisted
      - review_required
      - mutation_policy
      - authorization
      properties:
        proposal:
          type: object
          additionalProperties: true
        persisted:
          type: boolean
        review_required:
          type: boolean
          enum:
          - true
        mutation_policy:
          type: string
        authorization:
          type: string
    FeedbackProposalRequest:
      type: object
      required:
      - project_id
      - feedback_type
      - proposed
      - evidence
      - rationale
      properties:
        project_id:
          type: string
          pattern: ^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$
        feedback_type:
          type: string
          enum:
          - classification
          - alternative
          - metadata
          - stale
          - other
        proposed:
          type: object
          minProperties: 1
          additionalProperties: true
        evidence:
          type: array
          minItems: 1
          maxItems: 10
          items:
            type: object
            additionalProperties: true
        rationale:
          type: string
          minLength: 12
          maxLength: 2000
        source_agent:
          type: string
          maxLength: 200
        source_url:
          type: string
          format: uri
    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'
  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.