summaryrefslogtreecommitdiffstats
path: root/feature-healthcheck/src/main/resources/openapi/openapi.yaml
blob: a16b60b7d6e89215cde8706bd85a342ffc837be9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
#  ============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