Helena Bioinformatics Backup API

openapi: 3.2.0
info:
  title: Helix Insight - Variant Analysis Service Backup API
  description: AI-powered variant analysis and interpretation service
  version: 0.1.0
tags:
- name: Backup
paths:
  /api/v1/admin/backup:
    post:
      tags:
      - Backup
      summary: Start a new backup
      description: 'Start a new platform backup.


        Launches backup as a background task. Poll

        /backup/status/{backup_id} for progress.


        Requires admin role. Only one operation can run at a time.'
      operationId: start_backup_api_v1_admin_backup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartBackupRequest'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartBackupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/admin/backup/status/{backup_id}:
    get:
      tags:
      - Backup
      summary: Get backup or restore status
      description: 'Poll backup/restore execution status.


        Returns current progress, step name, and any error.

        Works for both backup_id and restore_id.

        Accessible to all authenticated users.'
      operationId: get_backup_status_api_v1_admin_backup_status__backup_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: backup_id
        in: path
        required: true
        schema:
          type: string
          title: Backup Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/backups:
    get:
      tags:
      - Backup
      summary: List all backups
      description: 'List all existing backups with summary information.


        Returns backups sorted by creation date (newest first).

        Accessible to all authenticated users.'
      operationId: list_backups_api_v1_admin_backups_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupListResponse'
      security:
      - HTTPBearer: []
  /api/v1/admin/backup/{backup_id}:
    delete:
      tags:
      - Backup
      summary: Delete a backup
      description: 'Delete a backup from disk.


        Cannot delete a currently running backup.

        Requires admin role.'
      operationId: delete_backup_api_v1_admin_backup__backup_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: backup_id
        in: path
        required: true
        schema:
          type: string
          title: Backup Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBackupResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/backup/{backup_id}/restore:
    post:
      tags:
      - Backup
      summary: Restore from a backup
      description: 'Restore platform from a backup.


        DESTRUCTIVE OPERATION:

        - Overwrites current PostgreSQL data

        - Replaces session outputs

        - Replaces literature/reference databases (if present in backup)


        Safety measures:

        - confirm_backup_id must match the URL backup_id

        - A pre-restore quick backup is created automatically

        - Only successful backups can be restored


        Requires admin role. Only one operation can run at a time.'
      operationId: restore_backup_api_v1_admin_backup__backup_id__restore_post
      security:
      - HTTPBearer: []
      parameters:
      - name: backup_id
        in: path
        required: true
        schema:
          type: string
          title: Backup Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreBackupRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestoreStartedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RestoreStartedResponse:
      properties:
        backup_id:
          type: string
          title: Backup Id
        restore_id:
          type: string
          title: Restore Id
        pre_restore_backup_id:
          type: string
          title: Pre Restore Backup Id
        status:
          $ref: '#/components/schemas/BackupStatus'
      type: object
      required:
      - backup_id
      - restore_id
      - pre_restore_backup_id
      - status
      title: RestoreStartedResponse
      description: Response after initiating a restore.
    BackupListResponse:
      properties:
        backups:
          items:
            $ref: '#/components/schemas/BackupSummary'
          type: array
          title: Backups
        total:
          type: integer
          title: Total
      type: object
      required:
      - backups
      - total
      title: BackupListResponse
      description: Response listing all backups.
    BackupStatus:
      type: string
      enum:
      - started
      - running
      - completed
      - failed
      title: BackupStatus
      description: Backup execution status.
    BackupStatusResponse:
      properties:
        backup_id:
          type: string
          title: Backup Id
        status:
          $ref: '#/components/schemas/BackupStatus'
        progress:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Progress
          description: Progress percentage
          default: 0
        current_step:
          type: string
          title: Current Step
          default: ''
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - backup_id
      - status
      title: BackupStatusResponse
      description: Response for backup status polling.
    BackupSummary:
      properties:
        backup_id:
          type: string
          title: Backup Id
        level:
          type: string
          title: Level
        status:
          type: string
          title: Status
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        duration_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Seconds
        total_size_bytes:
          type: integer
          title: Total Size Bytes
          default: 0
      type: object
      required:
      - backup_id
      - level
      - status
      title: BackupSummary
      description: Summary of a single backup.
    RestoreBackupRequest:
      properties:
        confirm_backup_id:
          type: string
          title: Confirm Backup Id
          description: Must match the backup_id in the URL to confirm restore
      type: object
      required:
      - confirm_backup_id
      title: RestoreBackupRequest
      description: Request to restore from a backup.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StartBackupRequest:
      properties:
        level:
          $ref: '#/components/schemas/BackupLevel'
          description: 'Backup level: quick (PostgreSQL + sessions), full (+ literature DB), complete (+ reference DB)'
          default: quick
      type: object
      title: StartBackupRequest
      description: Request to start a new backup.
    BackupLevel:
      type: string
      enum:
      - quick
      - full
      - complete
      title: BackupLevel
      description: Backup level enumeration.
    StartBackupResponse:
      properties:
        backup_id:
          type: string
          title: Backup Id
        status:
          $ref: '#/components/schemas/BackupStatus'
      type: object
      required:
      - backup_id
      - status
      title: StartBackupResponse
      description: Response after starting a backup.
    DeleteBackupResponse:
      properties:
        backup_id:
          type: string
          title: Backup Id
        deleted:
          type: boolean
          title: Deleted
      type: object
      required:
      - backup_id
      - deleted
      title: DeleteBackupResponse
      description: Response after deleting a backup.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer