@twin.org/auditable-item-graph-service 0.0.1-next.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +21 -0
- package/dist/cjs/index.cjs +1606 -0
- package/dist/esm/index.mjs +1596 -0
- package/dist/types/auditableItemGraphRoutes.d.ts +45 -0
- package/dist/types/auditableItemGraphService.d.ts +123 -0
- package/dist/types/entities/auditableItemGraphAlias.d.ts +30 -0
- package/dist/types/entities/auditableItemGraphChangeset.d.ts +30 -0
- package/dist/types/entities/auditableItemGraphEdge.d.ts +30 -0
- package/dist/types/entities/auditableItemGraphPatch.d.ts +21 -0
- package/dist/types/entities/auditableItemGraphResource.d.ts +26 -0
- package/dist/types/entities/auditableItemGraphVertex.d.ts +45 -0
- package/dist/types/index.d.ts +11 -0
- package/dist/types/models/IAuditableItemGraphServiceConfig.d.ts +5 -0
- package/dist/types/models/IAuditableItemGraphServiceContext.d.ts +17 -0
- package/dist/types/restEntryPoints.d.ts +2 -0
- package/dist/types/schema.d.ts +4 -0
- package/docs/changelog.md +5 -0
- package/docs/examples.md +1 -0
- package/docs/open-api/spec.json +1032 -0
- package/docs/reference/classes/AuditableItemGraphAlias.md +61 -0
- package/docs/reference/classes/AuditableItemGraphChangeset.md +61 -0
- package/docs/reference/classes/AuditableItemGraphEdge.md +61 -0
- package/docs/reference/classes/AuditableItemGraphPatch.md +45 -0
- package/docs/reference/classes/AuditableItemGraphResource.md +53 -0
- package/docs/reference/classes/AuditableItemGraphService.md +289 -0
- package/docs/reference/classes/AuditableItemGraphVertex.md +85 -0
- package/docs/reference/functions/auditableItemGraphCreate.md +25 -0
- package/docs/reference/functions/auditableItemGraphGet.md +25 -0
- package/docs/reference/functions/auditableItemGraphList.md +25 -0
- package/docs/reference/functions/auditableItemGraphUpdate.md +25 -0
- package/docs/reference/functions/generateRestRoutesAuditableItemGraph.md +21 -0
- package/docs/reference/functions/initSchema.md +9 -0
- package/docs/reference/index.md +29 -0
- package/docs/reference/interfaces/IAuditableItemGraphServiceConfig.md +3 -0
- package/docs/reference/variables/restEntryPoints.md +3 -0
- package/docs/reference/variables/tagsAuditableItemGraph.md +5 -0
- package/locales/en.json +19 -0
- package/package.json +51 -0
|
@@ -0,0 +1,1032 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.1.0",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "TWIN - Test Endpoints",
|
|
5
|
+
"description": "REST API for TWIN - Test Endpoints.",
|
|
6
|
+
"version": "1.0.0",
|
|
7
|
+
"license": {
|
|
8
|
+
"name": "Apache 2.0 License",
|
|
9
|
+
"url": "https://opensource.org/licenses/Apache-2.0"
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"servers": [
|
|
13
|
+
{
|
|
14
|
+
"url": "https://localhost"
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"tags": [
|
|
18
|
+
{
|
|
19
|
+
"name": "Auditable Item Graph",
|
|
20
|
+
"description": "Endpoints which are modelled to access an auditable item graph contract."
|
|
21
|
+
}
|
|
22
|
+
],
|
|
23
|
+
"paths": {
|
|
24
|
+
"/auditable-item-graph": {
|
|
25
|
+
"post": {
|
|
26
|
+
"operationId": "auditableItemGraphCreate",
|
|
27
|
+
"summary": "Create a new graph vertex",
|
|
28
|
+
"tags": [
|
|
29
|
+
"Auditable Item Graph"
|
|
30
|
+
],
|
|
31
|
+
"security": [
|
|
32
|
+
{
|
|
33
|
+
"jwtBearerAuthScheme": []
|
|
34
|
+
}
|
|
35
|
+
],
|
|
36
|
+
"requestBody": {
|
|
37
|
+
"description": "Create an auditable item graph vertex.",
|
|
38
|
+
"required": true,
|
|
39
|
+
"content": {
|
|
40
|
+
"application/json": {
|
|
41
|
+
"schema": {
|
|
42
|
+
"$ref": "#/components/schemas/AuditableItemGraphCreateRequest"
|
|
43
|
+
},
|
|
44
|
+
"examples": {
|
|
45
|
+
"auditableItemGraphCreateRequestExample": {
|
|
46
|
+
"value": {
|
|
47
|
+
"vertexObject": {
|
|
48
|
+
"@context": "http://schema.org/",
|
|
49
|
+
"@type": "Note",
|
|
50
|
+
"content": "This is a simple note"
|
|
51
|
+
},
|
|
52
|
+
"aliases": [
|
|
53
|
+
{
|
|
54
|
+
"id": "bar456",
|
|
55
|
+
"aliasObject": {
|
|
56
|
+
"@context": "http://schema.org/",
|
|
57
|
+
"@type": "Note",
|
|
58
|
+
"content": "This is a simple note"
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"id": "foo321",
|
|
63
|
+
"aliasObject": {
|
|
64
|
+
"@context": "http://schema.org/",
|
|
65
|
+
"@type": "Note",
|
|
66
|
+
"content": "This is a simple note"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
|
+
"resources": [
|
|
71
|
+
{
|
|
72
|
+
"id": "resource1",
|
|
73
|
+
"resourceObject": {
|
|
74
|
+
"@context": "http://schema.org/",
|
|
75
|
+
"@type": "Note",
|
|
76
|
+
"content": "This is a simple note"
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"id": "resource2",
|
|
81
|
+
"resourceObject": {
|
|
82
|
+
"@context": "http://schema.org/",
|
|
83
|
+
"@type": "Note",
|
|
84
|
+
"content": "This is a simple note"
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"edges": [
|
|
89
|
+
{
|
|
90
|
+
"id": "edge1",
|
|
91
|
+
"edgeRelationship": "frenemy",
|
|
92
|
+
"edgeObject": {
|
|
93
|
+
"@context": "http://schema.org/",
|
|
94
|
+
"@type": "Note",
|
|
95
|
+
"content": "This is a simple note"
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"id": "edge2",
|
|
100
|
+
"edgeRelationship": "end",
|
|
101
|
+
"edgeObject": {
|
|
102
|
+
"@context": "http://schema.org/",
|
|
103
|
+
"@type": "Note",
|
|
104
|
+
"content": "This is a simple note"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"responses": {
|
|
115
|
+
"201": {
|
|
116
|
+
"description": "The rest request ended in created response.",
|
|
117
|
+
"headers": {
|
|
118
|
+
"location": {
|
|
119
|
+
"schema": {
|
|
120
|
+
"type": "string"
|
|
121
|
+
},
|
|
122
|
+
"description": "e.g. aig:1234567890"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
"400": {
|
|
127
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
128
|
+
"content": {
|
|
129
|
+
"application/json": {
|
|
130
|
+
"schema": {
|
|
131
|
+
"$ref": "#/components/schemas/Error"
|
|
132
|
+
},
|
|
133
|
+
"examples": {
|
|
134
|
+
"exampleResponse": {
|
|
135
|
+
"value": {
|
|
136
|
+
"name": "GeneralError",
|
|
137
|
+
"message": "component.error",
|
|
138
|
+
"properties": {
|
|
139
|
+
"foo": "bar"
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"401": {
|
|
148
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
149
|
+
"content": {
|
|
150
|
+
"application/json": {
|
|
151
|
+
"schema": {
|
|
152
|
+
"$ref": "#/components/schemas/Error"
|
|
153
|
+
},
|
|
154
|
+
"examples": {
|
|
155
|
+
"exampleResponse": {
|
|
156
|
+
"value": {
|
|
157
|
+
"name": "UnauthorizedError",
|
|
158
|
+
"message": "component.error"
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
"500": {
|
|
166
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
167
|
+
"content": {
|
|
168
|
+
"application/json": {
|
|
169
|
+
"schema": {
|
|
170
|
+
"$ref": "#/components/schemas/Error"
|
|
171
|
+
},
|
|
172
|
+
"examples": {
|
|
173
|
+
"exampleResponse": {
|
|
174
|
+
"value": {
|
|
175
|
+
"name": "InternalServerError",
|
|
176
|
+
"message": "component.error"
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
"get": {
|
|
186
|
+
"operationId": "auditableItemGraphList",
|
|
187
|
+
"summary": "Query graph vertices by id or alias",
|
|
188
|
+
"tags": [
|
|
189
|
+
"Auditable Item Graph"
|
|
190
|
+
],
|
|
191
|
+
"parameters": [
|
|
192
|
+
{
|
|
193
|
+
"name": "id",
|
|
194
|
+
"description": "The id or alias to try and find.",
|
|
195
|
+
"in": "query",
|
|
196
|
+
"required": false,
|
|
197
|
+
"schema": {
|
|
198
|
+
"type": "string"
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"name": "idMode",
|
|
203
|
+
"description": "Which field to look in with the id, defaults to both.",
|
|
204
|
+
"in": "query",
|
|
205
|
+
"required": false,
|
|
206
|
+
"schema": {
|
|
207
|
+
"type": "string",
|
|
208
|
+
"enum": [
|
|
209
|
+
"id",
|
|
210
|
+
"alias",
|
|
211
|
+
"both"
|
|
212
|
+
]
|
|
213
|
+
}
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "orderBy",
|
|
217
|
+
"description": "The order for the results, default to dateCreated.",
|
|
218
|
+
"in": "query",
|
|
219
|
+
"required": false,
|
|
220
|
+
"schema": {
|
|
221
|
+
"type": "string",
|
|
222
|
+
"enum": [
|
|
223
|
+
"dateCreated",
|
|
224
|
+
"dateModified"
|
|
225
|
+
]
|
|
226
|
+
}
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
"name": "orderByDirection",
|
|
230
|
+
"description": "The direction for the order, defaults to desc.",
|
|
231
|
+
"in": "query",
|
|
232
|
+
"required": false,
|
|
233
|
+
"schema": {
|
|
234
|
+
"$ref": "#/components/schemas/SortDirection"
|
|
235
|
+
}
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"name": "properties",
|
|
239
|
+
"description": "The properties to return as a comma separated list, defaults to \"id,dateCreated,aliases,vertexObject\".",
|
|
240
|
+
"in": "query",
|
|
241
|
+
"required": false,
|
|
242
|
+
"schema": {
|
|
243
|
+
"type": "string"
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"name": "cursor",
|
|
248
|
+
"description": "The optional cursor to get next chunk.",
|
|
249
|
+
"in": "query",
|
|
250
|
+
"required": false,
|
|
251
|
+
"schema": {
|
|
252
|
+
"type": "string"
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "pageSize",
|
|
257
|
+
"description": "The maximum number of entities in a page.",
|
|
258
|
+
"in": "query",
|
|
259
|
+
"required": false,
|
|
260
|
+
"schema": {
|
|
261
|
+
"type": "number"
|
|
262
|
+
}
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "accept",
|
|
266
|
+
"in": "header",
|
|
267
|
+
"required": true,
|
|
268
|
+
"schema": {
|
|
269
|
+
"type": "string"
|
|
270
|
+
},
|
|
271
|
+
"style": "simple"
|
|
272
|
+
}
|
|
273
|
+
],
|
|
274
|
+
"security": [
|
|
275
|
+
{
|
|
276
|
+
"jwtBearerAuthScheme": []
|
|
277
|
+
}
|
|
278
|
+
],
|
|
279
|
+
"responses": {
|
|
280
|
+
"200": {
|
|
281
|
+
"description": "The response to getting the a list of the vertices with matching ids or aliases.",
|
|
282
|
+
"content": {
|
|
283
|
+
"application/json": {
|
|
284
|
+
"schema": {
|
|
285
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
|
|
286
|
+
},
|
|
287
|
+
"examples": {
|
|
288
|
+
"auditableItemGraphListResponseExample": {
|
|
289
|
+
"value": {
|
|
290
|
+
"@context": [
|
|
291
|
+
"https://schema.twindev.org/aig/",
|
|
292
|
+
"https://schema.org/"
|
|
293
|
+
],
|
|
294
|
+
"type": "AuditableItemGraphVertexList",
|
|
295
|
+
"vertices": [
|
|
296
|
+
{
|
|
297
|
+
"@context": [
|
|
298
|
+
"https://schema.twindev.org/aig/",
|
|
299
|
+
"https://schema.org/"
|
|
300
|
+
],
|
|
301
|
+
"type": "AuditableItemGraphVertex",
|
|
302
|
+
"id": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
303
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
304
|
+
"aliases": [
|
|
305
|
+
{
|
|
306
|
+
"@context": [
|
|
307
|
+
"https://schema.twindev.org/aig/",
|
|
308
|
+
"https://schema.org/"
|
|
309
|
+
],
|
|
310
|
+
"type": "AuditableItemGraphAlias",
|
|
311
|
+
"id": "foo4",
|
|
312
|
+
"dateCreated": "2024-08-22T11:55:16.271Z"
|
|
313
|
+
}
|
|
314
|
+
]
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
"cursor": "1"
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
}
|
|
321
|
+
},
|
|
322
|
+
"application/ld+json": {
|
|
323
|
+
"schema": {
|
|
324
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertexList"
|
|
325
|
+
},
|
|
326
|
+
"examples": {
|
|
327
|
+
"auditableItemGraphJsonLdListResponseExample": {
|
|
328
|
+
"value": {
|
|
329
|
+
"@context": [
|
|
330
|
+
"https://schema.twindev.org/aig/",
|
|
331
|
+
"https://schema.org/"
|
|
332
|
+
],
|
|
333
|
+
"type": "AuditableItemGraphVertexList",
|
|
334
|
+
"vertices": [
|
|
335
|
+
{
|
|
336
|
+
"@context": [
|
|
337
|
+
"https://schema.twindev.org/aig/",
|
|
338
|
+
"https://schema.org/"
|
|
339
|
+
],
|
|
340
|
+
"type": "AuditableItemGraphVertex",
|
|
341
|
+
"id": "0101010101010101010101010101010101010101010101010101010101010101",
|
|
342
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
343
|
+
"aliases": [
|
|
344
|
+
{
|
|
345
|
+
"@context": [
|
|
346
|
+
"https://schema.twindev.org/aig/",
|
|
347
|
+
"https://schema.org/"
|
|
348
|
+
],
|
|
349
|
+
"type": "AuditableItemGraphAlias",
|
|
350
|
+
"id": "foo4",
|
|
351
|
+
"dateCreated": "2024-08-22T11:55:16.271Z"
|
|
352
|
+
}
|
|
353
|
+
]
|
|
354
|
+
}
|
|
355
|
+
],
|
|
356
|
+
"cursor": "1"
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
"headers": {
|
|
363
|
+
"content-type": {
|
|
364
|
+
"schema": {
|
|
365
|
+
"type": "string"
|
|
366
|
+
},
|
|
367
|
+
"description": "e.g. application/ld+json"
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
},
|
|
371
|
+
"400": {
|
|
372
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
373
|
+
"content": {
|
|
374
|
+
"application/json": {
|
|
375
|
+
"schema": {
|
|
376
|
+
"$ref": "#/components/schemas/Error"
|
|
377
|
+
},
|
|
378
|
+
"examples": {
|
|
379
|
+
"exampleResponse": {
|
|
380
|
+
"value": {
|
|
381
|
+
"name": "GeneralError",
|
|
382
|
+
"message": "component.error",
|
|
383
|
+
"properties": {
|
|
384
|
+
"foo": "bar"
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"401": {
|
|
393
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
394
|
+
"content": {
|
|
395
|
+
"application/json": {
|
|
396
|
+
"schema": {
|
|
397
|
+
"$ref": "#/components/schemas/Error"
|
|
398
|
+
},
|
|
399
|
+
"examples": {
|
|
400
|
+
"exampleResponse": {
|
|
401
|
+
"value": {
|
|
402
|
+
"name": "UnauthorizedError",
|
|
403
|
+
"message": "component.error"
|
|
404
|
+
}
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
"500": {
|
|
411
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
412
|
+
"content": {
|
|
413
|
+
"application/json": {
|
|
414
|
+
"schema": {
|
|
415
|
+
"$ref": "#/components/schemas/Error"
|
|
416
|
+
},
|
|
417
|
+
"examples": {
|
|
418
|
+
"exampleResponse": {
|
|
419
|
+
"value": {
|
|
420
|
+
"name": "InternalServerError",
|
|
421
|
+
"message": "component.error"
|
|
422
|
+
}
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
},
|
|
431
|
+
"/auditable-item-graph/{id}": {
|
|
432
|
+
"get": {
|
|
433
|
+
"operationId": "auditableItemGraphGet",
|
|
434
|
+
"summary": "Get a graph vertex",
|
|
435
|
+
"tags": [
|
|
436
|
+
"Auditable Item Graph"
|
|
437
|
+
],
|
|
438
|
+
"parameters": [
|
|
439
|
+
{
|
|
440
|
+
"name": "id",
|
|
441
|
+
"description": "The id of the vertex to get.",
|
|
442
|
+
"in": "path",
|
|
443
|
+
"required": true,
|
|
444
|
+
"schema": {
|
|
445
|
+
"type": "string"
|
|
446
|
+
},
|
|
447
|
+
"style": "simple",
|
|
448
|
+
"example": "aig:1234567890"
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
"name": "includeDeleted",
|
|
452
|
+
"description": "Whether to include deleted aliases, resource, edges, defaults to false.",
|
|
453
|
+
"in": "query",
|
|
454
|
+
"required": false,
|
|
455
|
+
"schema": {
|
|
456
|
+
"type": "boolean"
|
|
457
|
+
}
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "includeChangesets",
|
|
461
|
+
"description": "Whether to include the changesets of the vertex, defaults to false.",
|
|
462
|
+
"in": "query",
|
|
463
|
+
"required": false,
|
|
464
|
+
"schema": {
|
|
465
|
+
"type": "boolean"
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "verifySignatureDepth",
|
|
470
|
+
"description": "How many signatures to verify, none, current or all, defaults to \"none\".",
|
|
471
|
+
"in": "query",
|
|
472
|
+
"required": false,
|
|
473
|
+
"schema": {
|
|
474
|
+
"$ref": "#/components/schemas/VerifyDepth"
|
|
475
|
+
}
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"name": "accept",
|
|
479
|
+
"in": "header",
|
|
480
|
+
"required": true,
|
|
481
|
+
"schema": {
|
|
482
|
+
"type": "string"
|
|
483
|
+
},
|
|
484
|
+
"style": "simple",
|
|
485
|
+
"example": "application/json"
|
|
486
|
+
}
|
|
487
|
+
],
|
|
488
|
+
"security": [
|
|
489
|
+
{
|
|
490
|
+
"jwtBearerAuthScheme": []
|
|
491
|
+
}
|
|
492
|
+
],
|
|
493
|
+
"responses": {
|
|
494
|
+
"200": {
|
|
495
|
+
"description": "Response to getting an auditable item graph vertex.",
|
|
496
|
+
"content": {
|
|
497
|
+
"application/json": {
|
|
498
|
+
"schema": {
|
|
499
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertex"
|
|
500
|
+
},
|
|
501
|
+
"examples": {
|
|
502
|
+
"auditableItemGraphGetResponseExample": {
|
|
503
|
+
"value": {
|
|
504
|
+
"@context": [
|
|
505
|
+
"https://schema.twindev.org/aig/",
|
|
506
|
+
"https://schema.org/"
|
|
507
|
+
],
|
|
508
|
+
"type": "AuditableItemGraphVertex",
|
|
509
|
+
"id": "aig:1234567890",
|
|
510
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
511
|
+
"dateModified": "2024-08-22T11:55:16.271Z",
|
|
512
|
+
"vertexObject": {
|
|
513
|
+
"@context": "http://schema.org/",
|
|
514
|
+
"@type": "Note",
|
|
515
|
+
"content": "This is a simple note"
|
|
516
|
+
},
|
|
517
|
+
"aliases": [
|
|
518
|
+
{
|
|
519
|
+
"@context": [
|
|
520
|
+
"https://schema.twindev.org/aig/",
|
|
521
|
+
"https://schema.org/"
|
|
522
|
+
],
|
|
523
|
+
"type": "AuditableItemGraphAlias",
|
|
524
|
+
"id": "tst:1234567890",
|
|
525
|
+
"dateCreated": "2024-08-22T11:55:16.271Z"
|
|
526
|
+
}
|
|
527
|
+
]
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
},
|
|
532
|
+
"application/ld+json": {
|
|
533
|
+
"schema": {
|
|
534
|
+
"$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertex"
|
|
535
|
+
},
|
|
536
|
+
"examples": {
|
|
537
|
+
"auditableItemGraphJsonLdGetResponseExample": {
|
|
538
|
+
"value": {
|
|
539
|
+
"@context": [
|
|
540
|
+
"https://schema.twindev.org/aig/",
|
|
541
|
+
"https://schema.org/"
|
|
542
|
+
],
|
|
543
|
+
"type": "AuditableItemGraphVertex",
|
|
544
|
+
"id": "aig:1234567890",
|
|
545
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
546
|
+
"dateModified": "2024-08-22T11:55:16.271Z",
|
|
547
|
+
"vertexObject": {
|
|
548
|
+
"@context": "http://schema.org/",
|
|
549
|
+
"@type": "Note",
|
|
550
|
+
"content": "This is a simple note"
|
|
551
|
+
},
|
|
552
|
+
"aliases": [
|
|
553
|
+
{
|
|
554
|
+
"@context": [
|
|
555
|
+
"https://schema.twindev.org/aig/",
|
|
556
|
+
"https://schema.org/"
|
|
557
|
+
],
|
|
558
|
+
"type": "AuditableItemGraphAlias",
|
|
559
|
+
"dateCreated": "2024-08-22T11:55:16.271Z",
|
|
560
|
+
"id": "tst:1234567890"
|
|
561
|
+
}
|
|
562
|
+
]
|
|
563
|
+
}
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
},
|
|
568
|
+
"headers": {
|
|
569
|
+
"content-type": {
|
|
570
|
+
"schema": {
|
|
571
|
+
"type": "string"
|
|
572
|
+
},
|
|
573
|
+
"description": "e.g. application/ld+json"
|
|
574
|
+
}
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
"400": {
|
|
578
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
579
|
+
"content": {
|
|
580
|
+
"application/json": {
|
|
581
|
+
"schema": {
|
|
582
|
+
"$ref": "#/components/schemas/Error"
|
|
583
|
+
},
|
|
584
|
+
"examples": {
|
|
585
|
+
"exampleResponse": {
|
|
586
|
+
"value": {
|
|
587
|
+
"name": "GeneralError",
|
|
588
|
+
"message": "component.error",
|
|
589
|
+
"properties": {
|
|
590
|
+
"foo": "bar"
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
}
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
"401": {
|
|
599
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
600
|
+
"content": {
|
|
601
|
+
"application/json": {
|
|
602
|
+
"schema": {
|
|
603
|
+
"$ref": "#/components/schemas/Error"
|
|
604
|
+
},
|
|
605
|
+
"examples": {
|
|
606
|
+
"exampleResponse": {
|
|
607
|
+
"value": {
|
|
608
|
+
"name": "UnauthorizedError",
|
|
609
|
+
"message": "component.error"
|
|
610
|
+
}
|
|
611
|
+
}
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
}
|
|
615
|
+
},
|
|
616
|
+
"500": {
|
|
617
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
618
|
+
"content": {
|
|
619
|
+
"application/json": {
|
|
620
|
+
"schema": {
|
|
621
|
+
"$ref": "#/components/schemas/Error"
|
|
622
|
+
},
|
|
623
|
+
"examples": {
|
|
624
|
+
"exampleResponse": {
|
|
625
|
+
"value": {
|
|
626
|
+
"name": "InternalServerError",
|
|
627
|
+
"message": "component.error"
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
},
|
|
636
|
+
"put": {
|
|
637
|
+
"operationId": "auditableItemGraphUpdate",
|
|
638
|
+
"summary": "Update a graph vertex",
|
|
639
|
+
"tags": [
|
|
640
|
+
"Auditable Item Graph"
|
|
641
|
+
],
|
|
642
|
+
"parameters": [
|
|
643
|
+
{
|
|
644
|
+
"name": "id",
|
|
645
|
+
"description": "The id of the vertex to update.",
|
|
646
|
+
"in": "path",
|
|
647
|
+
"required": true,
|
|
648
|
+
"schema": {
|
|
649
|
+
"type": "string"
|
|
650
|
+
},
|
|
651
|
+
"style": "simple",
|
|
652
|
+
"example": "aig:1234567890"
|
|
653
|
+
}
|
|
654
|
+
],
|
|
655
|
+
"security": [
|
|
656
|
+
{
|
|
657
|
+
"jwtBearerAuthScheme": []
|
|
658
|
+
}
|
|
659
|
+
],
|
|
660
|
+
"requestBody": {
|
|
661
|
+
"description": "Update an auditable item graph vertex.",
|
|
662
|
+
"required": true,
|
|
663
|
+
"content": {
|
|
664
|
+
"application/json": {
|
|
665
|
+
"schema": {
|
|
666
|
+
"$ref": "#/components/schemas/AuditableItemGraphUpdateRequest"
|
|
667
|
+
},
|
|
668
|
+
"examples": {
|
|
669
|
+
"auditableItemGraphUpdateRequestExample": {
|
|
670
|
+
"value": {
|
|
671
|
+
"vertexObject": {
|
|
672
|
+
"@context": "http://schema.org/",
|
|
673
|
+
"@type": "Note",
|
|
674
|
+
"content": "This is a simple note"
|
|
675
|
+
},
|
|
676
|
+
"aliases": [
|
|
677
|
+
{
|
|
678
|
+
"id": "bar456",
|
|
679
|
+
"aliasObject": {
|
|
680
|
+
"@context": "http://schema.org/",
|
|
681
|
+
"@type": "Note",
|
|
682
|
+
"content": "This is a simple note"
|
|
683
|
+
}
|
|
684
|
+
},
|
|
685
|
+
{
|
|
686
|
+
"id": "foo321",
|
|
687
|
+
"aliasObject": {
|
|
688
|
+
"@context": "http://schema.org/",
|
|
689
|
+
"@type": "Note",
|
|
690
|
+
"content": "This is a simple note"
|
|
691
|
+
}
|
|
692
|
+
}
|
|
693
|
+
],
|
|
694
|
+
"resources": [
|
|
695
|
+
{
|
|
696
|
+
"id": "resource1",
|
|
697
|
+
"resourceObject": {
|
|
698
|
+
"@context": "http://schema.org/",
|
|
699
|
+
"@type": "Note",
|
|
700
|
+
"content": "This is a simple note"
|
|
701
|
+
}
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"id": "resource2",
|
|
705
|
+
"resourceObject": {
|
|
706
|
+
"@context": "http://schema.org/",
|
|
707
|
+
"@type": "Note",
|
|
708
|
+
"content": "This is a simple note"
|
|
709
|
+
}
|
|
710
|
+
}
|
|
711
|
+
],
|
|
712
|
+
"edges": [
|
|
713
|
+
{
|
|
714
|
+
"id": "edge1",
|
|
715
|
+
"edgeRelationship": "frenemy",
|
|
716
|
+
"edgeObject": {
|
|
717
|
+
"@context": "http://schema.org/",
|
|
718
|
+
"@type": "Note",
|
|
719
|
+
"content": "This is a simple note"
|
|
720
|
+
}
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"id": "edge2",
|
|
724
|
+
"edgeRelationship": "end",
|
|
725
|
+
"edgeObject": {
|
|
726
|
+
"@context": "http://schema.org/",
|
|
727
|
+
"@type": "Note",
|
|
728
|
+
"content": "This is a simple note"
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
]
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
}
|
|
737
|
+
},
|
|
738
|
+
"responses": {
|
|
739
|
+
"204": {
|
|
740
|
+
"description": "The rest request ended in success with no data."
|
|
741
|
+
},
|
|
742
|
+
"400": {
|
|
743
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
744
|
+
"content": {
|
|
745
|
+
"application/json": {
|
|
746
|
+
"schema": {
|
|
747
|
+
"$ref": "#/components/schemas/Error"
|
|
748
|
+
},
|
|
749
|
+
"examples": {
|
|
750
|
+
"exampleResponse": {
|
|
751
|
+
"value": {
|
|
752
|
+
"name": "GeneralError",
|
|
753
|
+
"message": "component.error",
|
|
754
|
+
"properties": {
|
|
755
|
+
"foo": "bar"
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
}
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
"401": {
|
|
764
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
765
|
+
"content": {
|
|
766
|
+
"application/json": {
|
|
767
|
+
"schema": {
|
|
768
|
+
"$ref": "#/components/schemas/Error"
|
|
769
|
+
},
|
|
770
|
+
"examples": {
|
|
771
|
+
"exampleResponse": {
|
|
772
|
+
"value": {
|
|
773
|
+
"name": "UnauthorizedError",
|
|
774
|
+
"message": "component.error"
|
|
775
|
+
}
|
|
776
|
+
}
|
|
777
|
+
}
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
},
|
|
781
|
+
"500": {
|
|
782
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
783
|
+
"content": {
|
|
784
|
+
"application/json": {
|
|
785
|
+
"schema": {
|
|
786
|
+
"$ref": "#/components/schemas/Error"
|
|
787
|
+
},
|
|
788
|
+
"examples": {
|
|
789
|
+
"exampleResponse": {
|
|
790
|
+
"value": {
|
|
791
|
+
"name": "InternalServerError",
|
|
792
|
+
"message": "component.error"
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
}
|
|
800
|
+
}
|
|
801
|
+
}
|
|
802
|
+
},
|
|
803
|
+
"components": {
|
|
804
|
+
"schemas": {
|
|
805
|
+
"AuditableItemGraphCreateRequest": {
|
|
806
|
+
"type": "object",
|
|
807
|
+
"properties": {
|
|
808
|
+
"vertexObject": {
|
|
809
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
810
|
+
},
|
|
811
|
+
"aliases": {
|
|
812
|
+
"type": "array",
|
|
813
|
+
"items": {
|
|
814
|
+
"type": "object",
|
|
815
|
+
"properties": {
|
|
816
|
+
"id": {
|
|
817
|
+
"type": "string"
|
|
818
|
+
},
|
|
819
|
+
"aliasFormat": {
|
|
820
|
+
"type": "string"
|
|
821
|
+
},
|
|
822
|
+
"aliasObject": {
|
|
823
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
824
|
+
}
|
|
825
|
+
},
|
|
826
|
+
"required": [
|
|
827
|
+
"id"
|
|
828
|
+
],
|
|
829
|
+
"additionalProperties": false
|
|
830
|
+
},
|
|
831
|
+
"description": "Alternative aliases that can be used to identify the vertex."
|
|
832
|
+
},
|
|
833
|
+
"resources": {
|
|
834
|
+
"type": "array",
|
|
835
|
+
"items": {
|
|
836
|
+
"type": "object",
|
|
837
|
+
"properties": {
|
|
838
|
+
"id": {
|
|
839
|
+
"type": "string"
|
|
840
|
+
},
|
|
841
|
+
"resourceObject": {
|
|
842
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
843
|
+
}
|
|
844
|
+
},
|
|
845
|
+
"required": [
|
|
846
|
+
"id"
|
|
847
|
+
],
|
|
848
|
+
"additionalProperties": false
|
|
849
|
+
},
|
|
850
|
+
"description": "The resources attached to the vertex."
|
|
851
|
+
},
|
|
852
|
+
"edges": {
|
|
853
|
+
"type": "array",
|
|
854
|
+
"items": {
|
|
855
|
+
"type": "object",
|
|
856
|
+
"properties": {
|
|
857
|
+
"id": {
|
|
858
|
+
"type": "string"
|
|
859
|
+
},
|
|
860
|
+
"edgeRelationship": {
|
|
861
|
+
"type": "string"
|
|
862
|
+
},
|
|
863
|
+
"edgeObject": {
|
|
864
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
865
|
+
}
|
|
866
|
+
},
|
|
867
|
+
"required": [
|
|
868
|
+
"id",
|
|
869
|
+
"edgeRelationship"
|
|
870
|
+
],
|
|
871
|
+
"additionalProperties": false
|
|
872
|
+
},
|
|
873
|
+
"description": "The edges connected to the vertex."
|
|
874
|
+
}
|
|
875
|
+
},
|
|
876
|
+
"additionalProperties": false,
|
|
877
|
+
"description": "The data to be used in the vertex."
|
|
878
|
+
},
|
|
879
|
+
"AuditableItemGraphUpdateRequest": {
|
|
880
|
+
"type": "object",
|
|
881
|
+
"properties": {
|
|
882
|
+
"vertexObject": {
|
|
883
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
884
|
+
},
|
|
885
|
+
"aliases": {
|
|
886
|
+
"type": "array",
|
|
887
|
+
"items": {
|
|
888
|
+
"type": "object",
|
|
889
|
+
"properties": {
|
|
890
|
+
"id": {
|
|
891
|
+
"type": "string"
|
|
892
|
+
},
|
|
893
|
+
"aliasFormat": {
|
|
894
|
+
"type": "string"
|
|
895
|
+
},
|
|
896
|
+
"aliasObject": {
|
|
897
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
898
|
+
}
|
|
899
|
+
},
|
|
900
|
+
"required": [
|
|
901
|
+
"id"
|
|
902
|
+
],
|
|
903
|
+
"additionalProperties": false
|
|
904
|
+
},
|
|
905
|
+
"description": "Alternative aliases that can be used to identify the vertex."
|
|
906
|
+
},
|
|
907
|
+
"resources": {
|
|
908
|
+
"type": "array",
|
|
909
|
+
"items": {
|
|
910
|
+
"type": "object",
|
|
911
|
+
"properties": {
|
|
912
|
+
"id": {
|
|
913
|
+
"type": "string"
|
|
914
|
+
},
|
|
915
|
+
"resourceObject": {
|
|
916
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
917
|
+
}
|
|
918
|
+
},
|
|
919
|
+
"required": [
|
|
920
|
+
"id"
|
|
921
|
+
],
|
|
922
|
+
"additionalProperties": false
|
|
923
|
+
},
|
|
924
|
+
"description": "The resources attached to the vertex."
|
|
925
|
+
},
|
|
926
|
+
"edges": {
|
|
927
|
+
"type": "array",
|
|
928
|
+
"items": {
|
|
929
|
+
"type": "object",
|
|
930
|
+
"properties": {
|
|
931
|
+
"id": {
|
|
932
|
+
"type": "string"
|
|
933
|
+
},
|
|
934
|
+
"edgeRelationship": {
|
|
935
|
+
"type": "string"
|
|
936
|
+
},
|
|
937
|
+
"edgeObject": {
|
|
938
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
"required": [
|
|
942
|
+
"id",
|
|
943
|
+
"edgeRelationship"
|
|
944
|
+
],
|
|
945
|
+
"additionalProperties": false
|
|
946
|
+
},
|
|
947
|
+
"description": "The edges connected to the vertex."
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
"additionalProperties": false,
|
|
951
|
+
"description": "The data to be used in the vertex."
|
|
952
|
+
},
|
|
953
|
+
"Error": {
|
|
954
|
+
"type": "object",
|
|
955
|
+
"properties": {
|
|
956
|
+
"name": {
|
|
957
|
+
"type": "string",
|
|
958
|
+
"description": "The name for the error."
|
|
959
|
+
},
|
|
960
|
+
"message": {
|
|
961
|
+
"type": "string",
|
|
962
|
+
"description": "The message for the error."
|
|
963
|
+
},
|
|
964
|
+
"source": {
|
|
965
|
+
"type": "string",
|
|
966
|
+
"description": "The source of the error."
|
|
967
|
+
},
|
|
968
|
+
"properties": {
|
|
969
|
+
"type": "object",
|
|
970
|
+
"additionalProperties": {},
|
|
971
|
+
"description": "Any additional information for the error."
|
|
972
|
+
},
|
|
973
|
+
"stack": {
|
|
974
|
+
"type": "string",
|
|
975
|
+
"description": "The stack trace for the error."
|
|
976
|
+
},
|
|
977
|
+
"inner": {
|
|
978
|
+
"$ref": "#/components/schemas/Error"
|
|
979
|
+
}
|
|
980
|
+
},
|
|
981
|
+
"required": [
|
|
982
|
+
"name",
|
|
983
|
+
"message"
|
|
984
|
+
],
|
|
985
|
+
"additionalProperties": false,
|
|
986
|
+
"description": "Model to describe serialized error."
|
|
987
|
+
},
|
|
988
|
+
"SortDirection": {
|
|
989
|
+
"anyOf": [
|
|
990
|
+
{
|
|
991
|
+
"type": "string",
|
|
992
|
+
"const": "asc",
|
|
993
|
+
"description": "Ascending."
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
"type": "string",
|
|
997
|
+
"const": "desc",
|
|
998
|
+
"description": "Descending."
|
|
999
|
+
}
|
|
1000
|
+
],
|
|
1001
|
+
"description": "The sort directions."
|
|
1002
|
+
},
|
|
1003
|
+
"VerifyDepth": {
|
|
1004
|
+
"anyOf": [
|
|
1005
|
+
{
|
|
1006
|
+
"type": "string",
|
|
1007
|
+
"const": "none",
|
|
1008
|
+
"description": "Do not verify any signatures."
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"type": "string",
|
|
1012
|
+
"const": "current",
|
|
1013
|
+
"description": "Verify only the most recent signature."
|
|
1014
|
+
},
|
|
1015
|
+
{
|
|
1016
|
+
"type": "string",
|
|
1017
|
+
"const": "all",
|
|
1018
|
+
"description": "Verify all the signatures."
|
|
1019
|
+
}
|
|
1020
|
+
],
|
|
1021
|
+
"description": "How deep to verify the signatures."
|
|
1022
|
+
}
|
|
1023
|
+
},
|
|
1024
|
+
"securitySchemes": {
|
|
1025
|
+
"jwtBearerAuthScheme": {
|
|
1026
|
+
"type": "http",
|
|
1027
|
+
"scheme": "bearer",
|
|
1028
|
+
"bearerFormat": "JWT"
|
|
1029
|
+
}
|
|
1030
|
+
}
|
|
1031
|
+
}
|
|
1032
|
+
}
|