openapi: 3.0.3
info:
  title: Apache JMeter REST Results Status API
  description: REST API for Apache JMeter test control and monitoring. Provides endpoints for starting, stopping, and monitoring load tests remotely, and for accessing test results.
  version: 5.6.3
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    email: dev@jmeter.apache.org
servers:
- url: http://localhost:4445
  description: JMeter REST API server
tags:
- name: Status
  description: Test status and monitoring
paths:
  /status:
    get:
      operationId: getStatus
      summary: Apache JMeter Get Status
      description: Get the current status of a running JMeter test.
      tags:
      - Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Test status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestStatus'
              examples:
                getStatus200Example:
                  summary: Default getStatus 200 response
                  x-microcks-default: true
                  value:
                    testId: test-1234
                    status: running
                    activeThreads: 100
                    elapsedTime: 30000
                    throughput: 150.5
                    errorRate: 0.5
components:
  schemas:
    TestStatus:
      type: object
      description: Current test status
      properties:
        testId:
          type: string
          example: test-1234
        status:
          type: string
          enum:
          - idle
          - running
          - stopping
          - stopped
          example: running
        activeThreads:
          type: integer
          description: Number of active virtual user threads
          example: 100
        elapsedTime:
          type: integer
          description: Elapsed test time in milliseconds
          example: 30000
        throughput:
          type: number
          description: Current throughput in requests per second
          example: 150.5
        errorRate:
          type: number
          description: Current error rate percentage
          example: 0.5