forked from hashgraph/guardian
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger-analytics.yaml
425 lines (425 loc) · 11.1 KB
/
swagger-analytics.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
openapi: 3.0.0
paths:
/analytics/report:
get:
operationId: AnalyticsApi_getCurrentReport
summary: Returns the status of the current report.
description: Returns the status of the current report.
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: &ref_0
- analytics
/analytics/report/update:
get:
operationId: AnalyticsApi_updateReport
summary: Update current report.
description: Update current report.
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/reports:
get:
operationId: AnalyticsApi_getReports
summary: Returns all reports.
description: Returns all reports.
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReportDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/reports/{uuid}:
get:
operationId: AnalyticsApi_getReport
summary: Returns report data by report uuid.
description: Returns report data by report uuid.
parameters:
- name: uuid
required: true
in: path
description: Report identifier
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/DataContainerDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/reports/{uuid}/export/csv:
get:
operationId: AnalyticsApi_exportToCsv
summary: Export report data in a csv file format.
description: Returns a csv file.
parameters:
- name: uuid
required: true
in: path
description: Report identifier
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
type: string
format: binary
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/reports/{uuid}/export/xlsx:
get:
operationId: AnalyticsApi_exportToXlsx
summary: Export report data in a xlsx file format.
description: Returns a xlsx file.
parameters:
- name: uuid
required: true
in: path
description: Report identifier
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
type: string
format: binary
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/dashboards:
get:
operationId: AnalyticsApi_getDashboards
summary: Returns all dashboards.
description: Returns all dashboards.
parameters: []
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DashboardDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/analytics/dashboards/{id}:
get:
operationId: AnalyticsApi_getDashboardById
summary: Returns dashboard by uuid.
description: Returns dashboard by uuid.
parameters:
- name: id
required: true
in: path
description: Dashboard identifier
schema:
type: string
responses:
'200':
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/DataContainerDTO'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorDTO'
tags: *ref_0
/metrics:
get:
operationId: MetricsApi_getMetrics
parameters: []
responses:
'200':
description: ''
tags:
- metrics
info:
title: Guardian
description: >-
The Guardian is a modular open-source solution that includes best-in-class
identity management and decentralized ledger technology (DLT) libraries. At
the heart of the Guardian solution is a sophisticated Policy Workflow Engine
(PWE) that enables applications to offer a requirements-based tokenization
implementation.
version: 2.27.1
contact:
name: API developer
url: https://envisionblockchain.com
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
tags: []
servers:
- url: /
description: version 1.0
components:
schemas:
ReportDTO:
type: object
properties:
uuid:
type: string
root:
type: string
status:
type: string
steep:
type: string
type:
type: string
progress:
type: number
maxProgress:
type: number
error:
type: string
required:
- uuid
- root
- status
- steep
- type
- progress
- maxProgress
- error
InternalServerErrorDTO:
type: object
properties:
code:
type: number
message:
type: string
required:
- code
- message
RateDTO:
type: object
properties:
name:
type: string
value:
type: number
required:
- name
- value
ReportDataDTO:
type: object
properties:
messages:
type: number
topics:
type: number
standardRegistries:
type: number
users:
type: number
policies:
type: number
instances:
type: number
modules:
type: number
documents:
type: number
vcDocuments:
type: number
vpDocuments:
type: number
didDocuments:
type: number
userTopic:
type: number
tokens:
type: number
fTokens:
type: number
nfTokens:
type: number
tags:
type: number
schemas:
type: number
systemSchemas:
type: number
revokeDocuments:
type: number
fTotalBalances:
type: number
nfTotalBalances:
type: number
topSize:
type: number
topSRByUsers:
$ref: '#/components/schemas/RateDTO'
topSRByPolicies:
$ref: '#/components/schemas/RateDTO'
topTagsByLabel:
$ref: '#/components/schemas/RateDTO'
topAllSchemasByName:
$ref: '#/components/schemas/RateDTO'
topSystemSchemasByName:
$ref: '#/components/schemas/RateDTO'
topSchemasByName:
$ref: '#/components/schemas/RateDTO'
topModulesByName:
$ref: '#/components/schemas/RateDTO'
topPoliciesByName:
$ref: '#/components/schemas/RateDTO'
topVersionsByName:
$ref: '#/components/schemas/RateDTO'
topPoliciesByDocuments:
$ref: '#/components/schemas/RateDTO'
topPoliciesByDID:
$ref: '#/components/schemas/RateDTO'
topPoliciesByVC:
$ref: '#/components/schemas/RateDTO'
topPoliciesByVP:
$ref: '#/components/schemas/RateDTO'
topPoliciesByRevoked:
$ref: '#/components/schemas/RateDTO'
topTokensByName:
$ref: '#/components/schemas/RateDTO'
topFTokensByName:
$ref: '#/components/schemas/RateDTO'
topNFTokensByName:
$ref: '#/components/schemas/RateDTO'
topFTokensByBalance:
$ref: '#/components/schemas/RateDTO'
topNFTokensByBalance:
$ref: '#/components/schemas/RateDTO'
required:
- messages
- topics
- standardRegistries
- users
- policies
- instances
- modules
- documents
- vcDocuments
- vpDocuments
- didDocuments
- userTopic
- tokens
- fTokens
- nfTokens
- tags
- schemas
- systemSchemas
- revokeDocuments
- fTotalBalances
- nfTotalBalances
- topSize
- topSRByUsers
- topSRByPolicies
- topTagsByLabel
- topAllSchemasByName
- topSystemSchemasByName
- topSchemasByName
- topModulesByName
- topPoliciesByName
- topVersionsByName
- topPoliciesByDocuments
- topPoliciesByDID
- topPoliciesByVC
- topPoliciesByVP
- topPoliciesByRevoked
- topTokensByName
- topFTokensByName
- topNFTokensByName
- topFTokensByBalance
- topNFTokensByBalance
DataContainerDTO:
type: object
properties:
uuid:
type: string
root:
type: string
report:
$ref: '#/components/schemas/ReportDataDTO'
required:
- uuid
- root
- report
DashboardDTO:
type: object
properties:
uuid:
type: string
root:
type: string
date:
type: string
required:
- uuid
- root
- date