openapi: 3.0.3
info:
  title: Quarkus Dev UI & Health/Metrics API
  description: >-
    Quarkus exposes management endpoints for health checks (via SmallRye Health),
    metrics (via Micrometer/SmallRye Metrics), and OpenAPI documentation. In dev
    mode, the Dev UI provides a web console with additional introspection
    endpoints. These endpoints are served under the /q path by default.
  version: 3.17.0
  contact:
    name: Quarkus Team
    url: https://quarkus.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: http://localhost:8080
    description: Default Quarkus development server
paths:
  /q/health:
    get:
      operationId: getHealth
      summary: Quarkus Overall health check
      description: Returns aggregate health status combining liveness, readiness, and startup checks
      tags:
        - Health
      responses:
        '200':
          description: All health checks pass
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: One or more health checks failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
  /q/health/live:
    get:
      operationId: getLiveness
      summary: Quarkus Liveness health check
      description: Indicates whether the application is running (for Kubernetes liveness probes)
      tags:
        - Health
      responses:
        '200':
          description: Application is live
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Application is not live
  /q/health/ready:
    get:
      operationId: getReadiness
      summary: Quarkus Readiness health check
      description: Indicates whether the application is ready to accept traffic (for Kubernetes readiness probes)
      tags:
        - Health
      responses:
        '200':
          description: Application is ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Application is not ready
  /q/health/started:
    get:
      operationId: getStartup
      summary: Quarkus Startup health check
      description: Indicates whether the application has completed startup (for Kubernetes startup probes)
      tags:
        - Health
      responses:
        '200':
          description: Application has started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '503':
          description: Application has not started
  /q/metrics:
    get:
      operationId: getMetrics
      summary: Quarkus Application metrics
      description: Returns application metrics in Prometheus exposition format
      tags:
        - Metrics
      responses:
        '200':
          description: Prometheus metrics
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: object
  /q/openapi:
    get:
      operationId: getOpenAPI
      summary: Quarkus OpenAPI document
      description: Returns the auto-generated OpenAPI specification for the application
      tags:
        - OpenAPI
      parameters:
        - name: format
          in: query
          schema:
            type: string
            enum: [json, yaml]
          description: Response format
      responses:
        '200':
          description: OpenAPI specification document
          content:
            application/json:
              schema:
                type: object
            application/yaml:
              schema:
                type: object
  /q/swagger-ui:
    get:
      operationId: getSwaggerUI
      summary: Quarkus Swagger UI
      description: Serves the Swagger UI for interactive API exploration (dev mode or when always-include is true)
      tags:
        - OpenAPI
      responses:
        '200':
          description: Swagger UI HTML page
          content:
            text/html:
              schema:
                type: string
  /q/info:
    get:
      operationId: getInfo
      summary: Quarkus Application info
      description: Returns build-time and runtime application information
      tags:
        - Info
      responses:
        '200':
          description: Application info
          content:
            application/json:
              schema:
                type: object
                properties:
                  os:
                    type: object
                    properties:
                      name: {type: string}
                      version: {type: string}
                      arch: {type: string}
                  java:
                    type: object
                    properties:
                      version: {type: string}
                  build:
                    type: object
                    properties:
                      group: {type: string}
                      artifact: {type: string}
                      version: {type: string}
                      time: {type: string}
  /q/dev-ui:
    get:
      operationId: getDevUI
      summary: Quarkus Dev UI dashboard
      description: Quarkus Dev UI web console (available only in dev mode) providing extensions, configuration, and build info
      tags:
        - Dev UI
      responses:
        '200':
          description: Dev UI HTML dashboard
          content:
            text/html:
              schema:
                type: string
components:
  schemas:
    HealthResponse:
      type: object
      description: MicroProfile Health response format
      properties:
        status:
          type: string
          enum: [UP, DOWN]
          description: Aggregate health status
        checks:
          type: array
          items:
            $ref: '#/components/schemas/HealthCheck'
    HealthCheck:
      type: object
      properties:
        name:
          type: string
          description: Health check procedure name
        status:
          type: string
          enum: [UP, DOWN]
        data:
          type: object
          additionalProperties: true
          description: Additional health check data
tags:
  - name: Dev UI
  - name: Health
  - name: Info
  - name: Metrics
  - name: OpenAPI