#  ============LICENSE_START=======================================================
#  Copyright (C) 2023 Nordix Foundation
#  ================================================================================
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
#
#  SPDX-License-Identifier: Apache-2.0
#  ============LICENSE_END=========================================================

openapi: 3.0.3
info:
  title: "PDP-D Healthcheck Documentation"
  description: PDP-D Healthcheck Services
  version: Swagger Server
servers:
- url: http://{drools-ip}:9696
  variables:
    drools-ip:
      default: 0.0.0.0
tags:
- name: pdp-d-healthcheck
  description: Drools PDP Healthcheck Operations
paths:
  /healthcheck:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Perform a system healthcheck
      description: Provides healthy status of the PDP-D plus the components defined in its configuration by using a REST interface
      operationId: healthcheck
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
  /healthcheck/engine:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Healthcheck engine
      description: Provides a Healthcheck on the engine
      operationId: engine
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
  /healthcheck/controllers:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Controllers Healthcheck
      description: Provides a Healthcheck on the configured controllers
      operationId: controllers
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
  /healthcheck/controllers/{controllerName}:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Controllers Healthcheck
      description: Provides a Healthcheck on the configured controllers
      parameters:
      - name: controllerName
        in: path
        description: controller Name
        required: true
        schema:
          type: string
      operationId: controllersName
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
  /healthcheck/clients:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Http Clients Healthcheck
      description: Provides a Healthcheck on the configured HTTP clients
      operationId: clients
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
  /healthcheck/clients/{clientsName}:
    get:
      tags:
        - pdp-d-healthcheck
      summary: Http Clients Healthcheck
      description: Provides a Healthcheck on the configured HTTP clients
      parameters:
      - name: clientsName
        in: path
        description: controller Name
        required: true
        schema:
          type: string
      operationId: clientsName
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Response'
components:
  schemas:
    Response:
      type: object