RunWhen rwfs API

openapi: 3.1.0
info:
  title: papi alert-query-proxy rwfs API
  description: RunWhen Platform API
  version: 2.0.0
tags:
- name: rwfs
paths:
  /api/v1/workspaces/{workspace_name}/rwfs/task-vitals:
    get:
      tags:
      - rwfs
      summary: Get Task Vitals
      description: 'Return per-task run-history vitals for the workspace.


        One entry per (slx_name, task_title) with any completed run_request

        history. Tasks that have never run are omitted — the rwfs UI renders

        grey pips by default for tasks it doesn''t see in this response.


        The aggregator caps each partition at the last

        ``RECENT_RUNS_WINDOW`` run_requests so cost stays O(N_tasks) even

        when individual tasks have thousands of historic runs.'
      operationId: get_task_vitals_api_v1_workspaces__workspace_name__rwfs_task_vitals_get
      parameters:
      - name: workspace_name
        in: path
        required: true
        schema:
          type: string
          title: Workspace Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskVitalsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
components:
  schemas:
    TaskVitalsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/TaskVitalsItem'
          type: array
          title: Items
          description: One entry per (slx, task) with any run history.
      type: object
      title: TaskVitalsResponse
      description: Workspace-scoped task-vitals payload.
    TaskVitalsItem:
      properties:
        slxName:
          type: string
          title: Slxname
          description: Full SLX name (`<workspace>--<short_name>`).
        taskTitle:
          type: string
          title: Tasktitle
          description: Task title as it appears in run_request.task_titles.
        recentStatuses:
          items:
            type: string
            enum:
            - ok
            - fail
            - warn
          type: array
          title: Recentstatuses
          description: Most-recent statuses for this task, newest-first. Length 1..3; drops anything older than the third newest run_request.
        openIssueCount:
          type: integer
          title: Openissuecount
          description: Count of currently-open issues (`closed_at IS NULL`) for this (slx, task), across all severities. Title-template normalised so PAPI's unresolved form (``${VAR}``) matches the resolved form stored on ``issues.task_title``.
        lastRunAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Lastrunat
          description: Timestamp of the most-recent completed run_request.
      type: object
      required:
      - slxName
      - taskTitle
      - recentStatuses
      - openIssueCount
      - lastRunAt
      title: TaskVitalsItem
      description: Per-(slx, task) run-history rollup.
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token from /api/v3/token/ or Auth0 login