forked from elastic/package-registry
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
386 lines (386 loc) · 9.2 KB
/
openapi.yml
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
openapi: 3.0.0
info:
title: EPR
version: '1.0'
license:
name: Elastic-License
url: 'https://github.com/elastic/package-registry/blob/master/LICENSE.txt'
description: Elastic Package Registry
servers:
- url: 'https://epr.elastic.co'
description: public
- url: 'https://epr-staging.elastic.co'
description: staging
- url: 'http://localhost:8080'
description: local
paths:
/:
get:
summary: GET info
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IndexData'
operationId: get
description: Info about the registry
/categories:
get:
summary: GET categories
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Category'
examples:
example-1:
value:
- id: logs
title: Logs
count: 20
- id: metrics
title: Metrics
count: 17
operationId: get-categories
description: List of the existing package categories and how many packages are in each category
parameters:
- $ref: '#/components/parameters/experimentalPackageParam'
/search:
get:
summary: Search packages
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BasePackage'
operationId: get-search
description: Search for packages. By default returns all the most recent packages available.
parameters:
- schema:
type: string
in: query
name: kibana
description: 'Filters out all the packages which are not compatible with the given Kibana version. If it is set to 7.3.1 and a package requires 7.4, the package will not be returned or an older compatible package will be shown. By default this endpoint always returns only the newest compatible package.'
- schema:
type: string
in: query
name: category
description: Filters the package by the given category. Available categories can be seend when going to /categories endpoint.
- schema:
type: string
in: query
name: package
description: 'Filters by a specific package name, for example mysql. In contrast to the other endpoints, it will return by default all versions of this package.'
- $ref: '#/components/parameters/internalPackageParam'
- $ref: '#/components/parameters/experimentalPackageParam'
'/package/{package}/{version}':
get:
summary: GET package info
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Package'
operationId: get-package
description: Info about a package
parameters:
- schema:
type: string
name: package
in: path
description: Name of the package
required: true
- schema:
type: string
name: version
in: path
required: true
description: Version of the package
components:
schemas:
IndexData:
title: IndexData
type: object
properties:
version:
type: string
service.name:
type: string
required:
- version
- service.name
Category:
title: Category
type: object
properties:
id:
type: string
title:
type: string
count:
type: integer
required:
- id
- title
- count
Image:
title: Image
type: object
properties:
path:
type: string
src:
type: string
title:
type: string
size:
type: string
type:
type: string
required:
- src
ProductRequirement:
title: Kibana
type: object
properties:
versions:
type: string
Requirement:
title: Requirement
type: object
properties:
Kibana:
$ref: '#/components/schemas/ProductRequirement'
required:
- Kibana
DataStream:
title: DataStream
type: object
properties:
type:
type: string
name:
type: string
title:
type: string
release:
type: string
ingest_pipeline:
type: string
streams:
$ref: '#/components/schemas/Stream'
package:
type: string
path:
type: string
required:
- title
- release
- type
Stream:
title: Stream
type: object
properties:
input:
type: string
vars:
$ref: '#/components/schemas/Variable'
dataset:
type: string
template_path:
type: string
title:
type: string
description:
type: string
enabled:
type: boolean
required:
- input
Input:
title: Input
type: object
properties:
type:
type: string
vars:
$ref: '#/components/schemas/Variable'
title:
type: string
description:
type: string
streams:
$ref: '#/components/schemas/Stream'
required:
- type
Variable:
title: Variable
type: object
properties:
name:
type: string
type:
type: string
title:
type: string
description:
type: string
multi:
type: boolean
required:
type: boolean
show_user:
type: boolean
default:
type: object
required:
- name
- type
- multi
- required
- show_user
BasePackage:
title: BasePackage
type: object
properties:
name:
type: string
title:
type: string
version:
type: string
release:
type: string
description:
type: string
type:
type: string
download:
type: string
downloads:
type: array
items:
$ref: '#/components/schemas/Download'
path:
type: string
icons:
type: array
items:
$ref: '#/components/schemas/Image'
internal:
type: string
required:
- name
- version
- description
- type
Download:
title: Download
type: object
properties:
path:
type: string
type:
type: string
required:
- path
- type
Package:
title: Package
allOf:
- $ref: '#/components/schemas/BasePackage'
- type: object
properties:
format_version:
type: string
readme:
type: string
license:
type: string
categories:
type: array
items:
type: string
requirement:
$ref: '#/components/schemas/Requirement'
screenshots:
$ref: '#/components/schemas/Image'
assets:
type: array
items:
type: string
policy_templates:
type: array
items:
$ref: '#/components/schemas/PolicyTemplate'
data_streams:
type: array
items:
$ref: '#/components/schemas/DataStream'
owner:
$ref: '#/components/schemas/Owner'
required:
- format_version
- categories
- requirement
description: ''
PolicyTemplate:
title: PolicyTemplate
type: object
properties:
name:
type: string
title:
type: string
description:
type: string
inputs:
type: array
items:
$ref: '#/components/schemas/Input'
multiple:
type: boolean
required:
- name
- title
- description
- inputs
Owner:
title: Owner
type: object
properties:
github:
type: string
parameters:
internalPackageParam:
name: internal
in: query
required: false
description: Set to true to also list internal packages
schema:
type: boolean
default: false
experimentalPackageParam:
name: experimental
in: query
required: false
description: Set to true to also list experimental packages
schema:
type: boolean
default: false