generated from RedHatInsights/insights-report-server
-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathopenapi.json
240 lines (240 loc) · 7.57 KB
/
openapi.json
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
{
"openapi": "3.0.0",
"info": {
"title": "Insights Content Service",
"description": "Insights Content Service",
"version": "1.0.0"
},
"paths": {
"/openapi.json": {
"get": {
"summary": "Returns the OpenAPI specification JSON.",
"description": "The OpenAPI specification of this REST API service that is represented in formatted and human-readable JSON is available under this endpoint.",
"operationId": "getOpenApi",
"responses": {
"200": {
"description": "A JSON containing the OpenAPI specification for this service.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"openapi": {
"type": "string"
},
"info": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"paths": {
"type": "object",
"description": "Available paths and their descriptions."
}
}
}
}
}
}
}
}
},
"/status": {
"get": {
"summary": "Returns a map of rule content states for all rules that has been read and parsed.",
"description": "Map of all rule content states",
"operationId": "getStatus",
"parameters": [
{
"name": "internal",
"description": "Turn-on filtering + select all internal rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "external",
"description": "Turn-on filtering + select all external rules",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rule",
"description": "Turn-on filtering + select rule specified by its name. Might be specified several times to select multiple rules.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "A JSON map of rule content states.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rules": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string"
},
"loaded": {
"type": "boolean"
},
"error": {
"type": "string"
}
}
},
"status": {
"type": "string",
"example": "ok"
}
}
}
}
}
}
}
}
},
"/groups": {
"get": {
"summary": "Returns a list of groups.",
"description": "List of all groups represented as an array of objects is returned in a response",
"operationId": "getGroups",
"responses": {
"200": {
"description": "A JSON array of groups.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"status": {
"type": "string",
"example": "ok"
}
}
}
}
}
}
}
}
},
"/content": {
"get": {
"summary": "Returns static content for all rules.",
"description": "The static content is taken from the memory cache, encoded in encoding/gob format and sent.",
"operationId": "getContent",
"responses": {
"200": {
"description": "A encoding/gob encoded value with all the static content.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rule-content": {
"type": "string"
},
"status": {
"type": "string",
"example": "ok"
}
}
}
}
}
}
}
}
},
"/info": {
"get": {
"summary": "Returns basic information about content service.",
"description": "InfoEndpoint returns basic information about content service version, utils repository version, commit hash etc.",
"operationId": "InfoEndpoint",
"responses": {
"200": {
"description": "A map containing information about content service.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"info": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"status": {
"type": "string",
"example": "ok"
}
}
}
}
}
}
}
}
},
"/metrics": {
"get": {
"summary": "Read all metrics exposed by this service",
"description": "Set of metrics provided by insights-operator-utils library providing total number of requests counter, API endpoints response times, and counter of HTTP status code responses. Additionally it is possible to consume all metrics provided by Go runtime. These metrics start with go_ and process_ prefixes.",
"operationId": "getMetrics",
"responses": {
"200": {
"content": {
"text/plain": {}
},
"description": "Default response containing all metrics in semi-structured text format"
}
}
}
}
}
}