-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
529 lines (512 loc) · 19.5 KB
/
openapi.yaml
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
openapi: 3.0.3
info:
title: Visier Consolidated Analytics APIs
description: Visier APIs for managing consolidated analytics (CA) tenants.
version: 22222222.99201.1256
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
x-api-status-urls: false
servers:
- url: https://{vanity-name}.api.visier.io
variables:
vanity-name:
default: vanity
tags:
- name: ConsolidatedAnalyticsV1Alpha
paths:
/v1alpha/admin/consolidated-analytics/tenants:
get:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Retrieve a list of all consolidated analytics tenants
operationId: ConsolidatedAnalyticsV1Alpha_ListTenants
description: >-
This API allows you to retrieve the full list of consolidated analytics
tenants in your administrating tenant.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The maximum number of tenants to return. The maximum value is 1000.
Default is 400.
name: limit
in: query
schema:
type: integer
format: int32
- description: The starting index of the first tenant to return. Default is 0.
name: start
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPITenantListResponseDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Create a consolidated analytics tenant
operationId: ConsolidatedAnalyticsV1Alpha_CreateTenant
description: |-
This API allows you to create a consolidated analytics tenant.
A new CA tenant has no source tenants and no excluded sources.
**Note:** CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPITenantCreateRequestDTO
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPITenantCreateRequestDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1alpha/admin/consolidated-analytics/tenants/:tenantId/excluded-sources:
get:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Retrieve a consolidated analytics tenant's excluded sources
operationId: ConsolidatedAnalyticsV1Alpha_ListExcludedSources
description: |-
This API allows you to retrieve a CA tenant's excluded sources.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPIExcludedSourcesListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
put:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Set a consolidated analytics tenant's excluded sources
operationId: ConsolidatedAnalyticsV1Alpha_SetExcludedSources
description: >-
This API defines the excluded sources for a consolidated analytics
tenant.
After you create a CA tenant, you may optionally define a list of excluded sources. The excluded sources are the sources whose data is excluded from the CA tenant.
You can also use this API to replace the list of excluded sources for an existing CA tenant.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExcludedSourcesBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPIExcludedSourcesListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Remove excluded sources from a consolidated analytics tenants
operationId: ConsolidatedAnalyticsV1Alpha_RemoveExcludedSources
description: >-
This API removes excluded sources from the list of excluded sources for
a consolidated analytics tenant.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExcludedSourcesBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPIExcludedSourcesListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
patch:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Add excluded sources to a consolidated analytics tenant
operationId: ConsolidatedAnalyticsV1Alpha_AddExcludedSources
description: >-
This API adds excluded sources to the list of excluded sources for a
consolidated analytics tenant.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExcludedSourcesBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPIExcludedSourcesListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1alpha/admin/consolidated-analytics/tenants/:tenantId/source-tenants:
get:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Retrieve a consolidated analytics tenant's source tenants
operationId: ConsolidatedAnalyticsV1Alpha_ListSourceTenants
description: |-
This API allows you to retrieve a CA tenant's source tenants.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
- description: >-
The maximum number of source tenants to return. The maximum value is
1000. Default is 400.
name: limit
in: query
schema:
type: integer
format: int32
- description: >-
The starting index of the first source tenant to return. Default is
0.
name: start
in: query
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPISourceTenantListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
put:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Set a consolidated analytics tenant's source tenants
operationId: ConsolidatedAnalyticsV1Alpha_SetSourceTenants
description: |-
This API defines the source tenants for a consolidated analytics tenant.
After you create a CA tenant, you must define a list of its source tenants. The source tenants are the tenants whose data is aggregated in the CA tenant.
You can also use this API to replace the list of source tenants for an existing CA tenant.
If successful, the response returns an updated list of source tenants.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
- description: >-
The maximum number of source tenants to return. The maximum value is
1000. Default is 400.
name: limit
in: query
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantCodeBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPISourceTenantListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
delete:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Remove source tenants from a consolidated analytics tenants
operationId: ConsolidatedAnalyticsV1Alpha_RemoveSourceTenants
description: >-
This API removes source tenants from the list of source tenants for a
consolidated analytics tenant.
If successful, the response returns an updated list of source tenants.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
- description: >-
The maximum number of source tenants to return. The maximum value is
1000. Default is 400.
name: limit
in: query
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantCodeBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPISourceTenantListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
patch:
tags:
- ConsolidatedAnalyticsV1Alpha
summary: Add source tenants to a consolidated analytics tenant
operationId: ConsolidatedAnalyticsV1Alpha_AddSourceTenants
description: >-
This API adds source tenants to the list of source tenants for a
consolidated analytics tenant.
If successful, the response returns an updated list of source tenants.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
parameters:
- description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
name: tenantId
in: query
schema:
type: string
- description: >-
The maximum number of source tenants to return. The maximum value is
1000. Default is 400.
name: limit
in: query
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantCodeBody'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/ConsolidatedAnalyticsAPISourceTenantListDTO
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
ConsolidatedAnalyticsAPIExcludedSourcesListDTO:
type: object
properties:
excludedSources:
description: A list of a CA tenant's excluded sources.
type: array
items:
type: string
ConsolidatedAnalyticsAPISourceTenantListDTO:
type: object
properties:
tenantCodes:
description: A list of a CA tenant's source tenants codes
type: array
items:
type: string
ConsolidatedAnalyticsAPITenantCreateRequestDTO:
type: object
properties:
tenantCode:
description: >-
The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is
the administrating tenant code and {YYY}
is the consolidated analytic tenant code.
type: string
ConsolidatedAnalyticsAPITenantListResponseDTO:
type: object
properties:
tenantCodes:
description: A list of CA tenants codes.
type: array
items:
type: string
ExcludedSourcesBody:
type: object
properties:
excludedSources:
description: A list of a CA tenant's excluded sources.
type: array
items:
type: string
GoogleProtobufAny:
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
type: object
properties:
'@type':
description: The type of the serialized message.
type: string
additionalProperties: true
TenantCodeBody:
type: object
properties:
tenantCodes:
description: >-
A list of a CA tenant's source tenants codes. The maximum length is
1000.
type: array
items:
type: string
Status:
description: The response structure for errors.
type: object
properties:
errorCode:
description: Error classification.
type: string
message:
description: Error message describing the root cause of the error.
type: string
rci:
description: Optional root cause identifier.
type: string