repowise-dev Jobs API

openapi: 3.2.0
info:
  title: repowise Jobs API
  description: REST API for repowise — codebase documentation engine
  version: 0.59.0
tags:
- name: Jobs
paths:
  /api/jobs:
    get:
      tags:
      - Jobs
      summary: List Jobs
      description: List generation jobs, optionally filtered by repository or status.
      operationId: list_jobs_api_jobs_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: repo_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Id
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobResponse'
                title: Response List Jobs Api Jobs Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
  /api/jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get Job
      description: Get a single generation job by ID.
      operationId: get_job_api_jobs__job_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
  /api/jobs/{job_id}/cancel:
    post:
      tags:
      - Jobs
      summary: Cancel Job
      description: 'Cancel a pending or running generation job.


        Actually stops the work: flips the job''s cooperative cancellation token

        (unwinding the CPU-bound pipeline phases) and cancels the background

        asyncio task (interrupting in-flight awaits, including LLM calls), then

        marks the job ``cancelled``. Also unblocks the active-job guard in

        /repos/{id}/sync when a job is stuck in ``pending`` because its

        background task never started.'
      operationId: cancel_job_api_jobs__job_id__cancel_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-repowise-stability: stable
  /api/jobs/{job_id}/stream:
    get:
      tags:
      - Jobs
      summary: Stream Job
      description: 'SSE progress stream for a generation job.


        Emits ``event: progress`` every second until the job reaches a terminal

        state, then emits ``event: done`` and closes. Pipeline messages recorded

        by the executor (phase starts, per-file warnings) are interleaved as

        ``event: message`` frames, and each progress frame carries the current

        ``phase`` label, so clients can render "Parsing files 1200/4000" instead

        of bare numbers.'
      operationId: stream_job_api_jobs__job_id__stream_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: token
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '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
    JobResponse:
      properties:
        id:
          type: string
          title: Id
        repository_id:
          type: string
          title: Repository Id
        status:
          type: string
          title: Status
        provider_name:
          type: string
          title: Provider Name
        model_name:
          type: string
          title: Model Name
        total_pages:
          type: integer
          title: Total Pages
        completed_pages:
          type: integer
          title: Completed Pages
        failed_pages:
          type: integer
          title: Failed Pages
        current_level:
          type: integer
          title: Current Level
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
        config:
          additionalProperties: true
          type: object
          title: Config
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
        stream_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Stream Token
      type: object
      required:
      - id
      - repository_id
      - status
      - provider_name
      - model_name
      - total_pages
      - completed_pages
      - failed_pages
      - current_level
      - error_message
      - config
      - created_at
      - updated_at
      - started_at
      - finished_at
      title: JobResponse
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization