repowise-dev Security API

openapi: 3.2.0
info:
  title: repowise Security API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: Security
paths:
  /api/repos/{repo_id}/security:
    get:
      tags:
      - Security
      summary: List Security Findings
      description: List security findings for a repository, with optional filters.
      operationId: list_security_findings_api_repos__repo_id__security_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      - name: file_path
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by relative file path
          title: File Path
        description: Filter by relative file path
      - name: severity
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Filter by severity: high, med, or low'
          title: Severity
        description: 'Filter by severity: high, med, or low'
      - name: history
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: If true, only full-history findings; if false, only working-tree findings; omit for both.
          title: History
        description: If true, only full-history findings; if false, only working-tree findings; omit for both.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityFindingResponse'
                title: Response List Security Findings Api Repos  Repo Id  Security Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
  /api/repos/{repo_id}/security/summary:
    get:
      tags:
      - Security
      summary: Security Summary
      description: 'When the pattern scan last ran (null when unknown), and every stored

        finding counted by shipped source, tests and docs.'
      operationId: security_summary_api_repos__repo_id__security_summary_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: path
        required: true
        schema:
          type: string
          title: Repo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecuritySummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    SecuritySummaryResponse:
      properties:
        scanned_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Scanned At
        total:
          type: integer
          title: Total
          default: 0
        class_counts:
          additionalProperties:
            type: integer
          propertyNames:
            enum:
            - source
            - test
            - docs
          type: object
          title: Class Counts
        source_high:
          type: integer
          title: Source High
          default: 0
      type: object
      title: SecuritySummaryResponse
    SecurityFindingResponse:
      properties:
        id:
          type: integer
          title: Id
        file_path:
          type: string
          title: File Path
        kind:
          type: string
          title: Kind
        severity:
          type: string
          title: Severity
        snippet:
          anyOf:
          - type: string
          - type: 'null'
          title: Snippet
        detected_at:
          type: string
          format: date-time
          title: Detected At
        line_number:
          anyOf:
          - type: integer
          - type: 'null'
          title: Line Number
        line_verified:
          type: boolean
          title: Line Verified
        commit_sha:
          anyOf:
          - type: string
          - type: 'null'
          title: Commit Sha
        commit_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Commit At
        found_in_history:
          type: boolean
          title: Found In History
        path_class:
          type: string
          enum:
          - source
          - test
          - docs
          title: Path Class
          default: source
      type: object
      required:
      - id
      - file_path
      - kind
      - severity
      - snippet
      - detected_at
      - line_number
      - line_verified
      - commit_sha
      - commit_at
      - found_in_history
      title: SecurityFindingResponse
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization