feature-healthcheck/src/main/resources/openapi/openapi.yaml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright (C) 2023 Nordix Foundation
   3 #  ================================================================================
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #        http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #  Unless required by applicable law or agreed to in writing, software
  11 #  distributed under the License is distributed on an "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #  See the License for the specific language governing permissions and
  14 #  limitations under the License.
  15 #
  16 #  SPDX-License-Identifier: Apache-2.0
  17 #  ============LICENSE_END=========================================================
  18
  19 openapi: 3.0.3
  20 info:
  21   title: "PDP-D Healthcheck Documentation"
  22   description: PDP-D Healthcheck Services
  23   version: Swagger Server
  24 servers:
  25 - url: http://{drools-ip}:9696
  26   variables:
  27     drools-ip:
  28       default: 0.0.0.0
  29 tags:
  30 - name: pdp-d-healthcheck
  31   description: Drools PDP Healthcheck Operations
  32 paths:
  33   /healthcheck:
  34     get:
  35       tags:
  36         - pdp-d-healthcheck
  37       summary: Perform a system healthcheck
  38       description: Provides healthy status of the PDP-D plus the components defined in its configuration by using a REST interface
  39       operationId: healthcheck
  40       responses:
  41         200:
  42           description: successful operation
  43           content:
  44             application/json:
  45               schema:
  46                 $ref: '#/components/schemas/Response'
  47             application/yaml:
  48               schema:
  49                 $ref: '#/components/schemas/Response'
  50   /healthcheck/engine:
  51     get:
  52       tags:
  53         - pdp-d-healthcheck
  54       summary: Healthcheck engine
  55       description: Provides a Healthcheck on the engine
  56       operationId: engine
  57       responses:
  58         200:
  59           description: successful operation
  60           content:
  61             application/json:
  62               schema:
  63                 $ref: '#/components/schemas/Response'
  64             application/yaml:
  65               schema:
  66                 $ref: '#/components/schemas/Response'
  67   /healthcheck/controllers:
  68     get:
  69       tags:
  70         - pdp-d-healthcheck
  71       summary: Controllers Healthcheck
  72       description: Provides a Healthcheck on the configured controllers
  73       operationId: controllers
  74       responses:
  75         200:
  76           description: successful operation
  77           content:
  78             application/json:
  79               schema:
  80                 $ref: '#/components/schemas/Response'
  81             application/yaml:
  82               schema:
  83                 $ref: '#/components/schemas/Response'
  84   /healthcheck/controllers/{controllerName}:
  85     get:
  86       tags:
  87         - pdp-d-healthcheck
  88       summary: Controllers Healthcheck
  89       description: Provides a Healthcheck on the configured controllers
  90       parameters:
  91       - name: controllerName
  92         in: path
  93         description: controller Name
  94         required: true
  95         schema:
  96           type: string
  97       operationId: controllersName
  98       responses:
  99         200:
 100           description: successful operation
 101           content:
 102             application/json:
 103               schema:
 104                 $ref: '#/components/schemas/Response'
 105             application/yaml:
 106               schema:
 107                 $ref: '#/components/schemas/Response'
 108   /healthcheck/clients:
 109     get:
 110       tags:
 111         - pdp-d-healthcheck
 112       summary: Http Clients Healthcheck
 113       description: Provides a Healthcheck on the configured HTTP clients
 114       operationId: clients
 115       responses:
 116         200:
 117           description: successful operation
 118           content:
 119             application/json:
 120               schema:
 121                 $ref: '#/components/schemas/Response'
 122             application/yaml:
 123               schema:
 124                 $ref: '#/components/schemas/Response'
 125   /healthcheck/clients/{clientsName}:
 126     get:
 127       tags:
 128         - pdp-d-healthcheck
 129       summary: Http Clients Healthcheck
 130       description: Provides a Healthcheck on the configured HTTP clients
 131       parameters:
 132       - name: clientsName
 133         in: path
 134         description: controller Name
 135         required: true
 136         schema:
 137           type: string
 138       operationId: clientsName
 139       responses:
 140         200:
 141           description: successful operation
 142           content:
 143             application/json:
 144               schema:
 145                 $ref: '#/components/schemas/Response'
 146             application/yaml:
 147               schema:
 148                 $ref: '#/components/schemas/Response'
 149 components:
 150   schemas:
 151     Response:
 152       type: object