repowise-dev History API

openapi: 3.2.0
info:
  title: repowise History API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: History
paths:
  /api/repos/{repo_id}/wins:
    get:
      tags:
      - History
      summary: Get Wins
      description: 'Findings resolved, files whose score rose and refactorings that landed.


        Positive only: an author gets credit, never a comparison.'
      operationId: get_wins_api_repos__repo_id__wins_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      - name: since
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: ISO 8601; default 30 days ago
          title: Since
        description: ISO 8601; default 30 days ago
      - name: until
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: ISO 8601, exclusive; default now
          title: Until
        description: ISO 8601, exclusive; default now
      - name: author
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Author email (any case) or exact name: that person''s wins only'
          title: Author
        description: 'Author email (any case) or exact name: that person''s wins only'
      - name: top
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          description: Items per section
          default: 10
          title: Top
        description: Items per section
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WinsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: internal
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WinsFindingsResolved:
      properties:
        count:
          type: integer
          title: Count
        commits:
          type: integer
          title: Commits
        top_commits:
          items:
            $ref: '#/components/schemas/WinsResolvingCommit'
          type: array
          title: Top Commits
          default: []
      type: object
      required:
      - count
      - commits
      title: WinsFindingsResolved
      description: 'Findings commits in the window resolved. Resolved findings are stored as

        per-commit counts, so the top items are the commits that resolved most.'
    WinsRefactoring:
      properties:
        file_path:
          type: string
          title: File Path
        target_symbol:
          type: string
          title: Target Symbol
        refactoring_type:
          type: string
          title: Refactoring Type
        resolved_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Resolved At
        before_ccn:
          anyOf:
          - type: integer
          - type: 'null'
          title: Before Ccn
        after_ccn:
          anyOf:
          - type: integer
          - type: 'null'
          title: After Ccn
        before_nloc:
          anyOf:
          - type: integer
          - type: 'null'
          title: Before Nloc
        after_nloc:
          anyOf:
          - type: integer
          - type: 'null'
          title: After Nloc
      type: object
      required:
      - file_path
      - target_symbol
      - refactoring_type
      title: WinsRefactoring
      description: 'A refactoring plan that landed: its target is gone or shrank as planned.'
    WinsFileGain:
      properties:
        path:
          type: string
          title: Path
        before:
          type: number
          title: Before
        after:
          type: number
          title: After
        gain:
          type: number
          title: Gain
      type: object
      required:
      - path
      - before
      - after
      - gain
      title: WinsFileGain
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WinsResolvingCommit:
      properties:
        sha:
          type: string
          title: Sha
        subject:
          type: string
          title: Subject
        author_name:
          type: string
          title: Author Name
        committed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Committed At
        resolved:
          type: integer
          title: Resolved
      type: object
      required:
      - sha
      - subject
      - author_name
      - resolved
      title: WinsResolvingCommit
    WinsRefactorings:
      properties:
        count:
          type: integer
          title: Count
        top:
          items:
            $ref: '#/components/schemas/WinsRefactoring'
          type: array
          title: Top
          default: []
      type: object
      required:
      - count
      title: WinsRefactorings
    WinsFilesImproved:
      properties:
        count:
          type: integer
          title: Count
        baseline_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Baseline At
        current_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Current At
        top:
          items:
            $ref: '#/components/schemas/WinsFileGain'
          type: array
          title: Top
          default: []
      type: object
      required:
      - count
      title: WinsFilesImproved
      description: 'Files commits in the window touched whose score rose between the snapshot

        at ``baseline_at`` and the one at ``current_at``.'
    WinsResponse:
      properties:
        since:
          type: string
          format: date-time
          title: Since
        until:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Until
        author:
          anyOf:
          - type: string
          - type: 'null'
          title: Author
        findings_resolved:
          $ref: '#/components/schemas/WinsFindingsResolved'
        files_improved:
          $ref: '#/components/schemas/WinsFilesImproved'
        refactorings_landed:
          $ref: '#/components/schemas/WinsRefactorings'
        unavailable:
          items:
            type: string
          type: array
          title: Unavailable
          default: []
      type: object
      required:
      - since
      - findings_resolved
      - files_improved
      - refactorings_landed
      title: WinsResponse
      description: 'What got better since ``since``. Positive only.


        With ``author`` every section narrows to that person''s commits and the

        files they touched. ``unavailable`` names wins the index cannot answer

        from stored data (no history is kept for them).'
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization