@twin.org/entity-storage-service 0.0.3-next.1 → 0.0.3-next.2
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/docs/changelog.md +16 -0
- package/docs/open-api/spec.json +268 -9
- package/package.json +2 -2
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @twin.org/entity-storage-service - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.3-next.1...entity-storage-service-v0.0.3-next.2) (2025-11-13)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* api docs ([4228736](https://github.com/twinfoundation/entity-storage/commit/4228736ebc8be212f81b3ccc70b56991d5d95032))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/entity-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
|
|
16
|
+
* devDependencies
|
|
17
|
+
* @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
|
|
18
|
+
|
|
3
19
|
## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.3-next.0...entity-storage-service-v0.0.3-next.1) (2025-11-10)
|
|
4
20
|
|
|
5
21
|
|
package/docs/open-api/spec.json
CHANGED
|
@@ -53,12 +53,62 @@
|
|
|
53
53
|
}
|
|
54
54
|
},
|
|
55
55
|
"responses": {
|
|
56
|
-
"
|
|
57
|
-
"description": "The rest request ended in success with no data."
|
|
56
|
+
"204": {
|
|
57
|
+
"description": "The rest request ended in success with no data."
|
|
58
|
+
},
|
|
59
|
+
"400": {
|
|
60
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
61
|
+
"content": {
|
|
62
|
+
"application/json": {
|
|
63
|
+
"schema": {
|
|
64
|
+
"$ref": "#/components/schemas/Error"
|
|
65
|
+
},
|
|
66
|
+
"examples": {
|
|
67
|
+
"exampleResponse": {
|
|
68
|
+
"value": {
|
|
69
|
+
"name": "GeneralError",
|
|
70
|
+
"message": "errorMessage",
|
|
71
|
+
"properties": {
|
|
72
|
+
"foo": "bar"
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
},
|
|
80
|
+
"401": {
|
|
81
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
82
|
+
"content": {
|
|
83
|
+
"application/json": {
|
|
84
|
+
"schema": {
|
|
85
|
+
"$ref": "#/components/schemas/Error"
|
|
86
|
+
},
|
|
87
|
+
"examples": {
|
|
88
|
+
"exampleResponse": {
|
|
89
|
+
"value": {
|
|
90
|
+
"name": "UnauthorizedError",
|
|
91
|
+
"message": "errorMessage"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"500": {
|
|
99
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
58
100
|
"content": {
|
|
59
|
-
"
|
|
101
|
+
"application/json": {
|
|
60
102
|
"schema": {
|
|
61
|
-
"$ref": "#/components/schemas/
|
|
103
|
+
"$ref": "#/components/schemas/Error"
|
|
104
|
+
},
|
|
105
|
+
"examples": {
|
|
106
|
+
"exampleResponse": {
|
|
107
|
+
"value": {
|
|
108
|
+
"name": "InternalServerError",
|
|
109
|
+
"message": "errorMessage"
|
|
110
|
+
}
|
|
111
|
+
}
|
|
62
112
|
}
|
|
63
113
|
}
|
|
64
114
|
}
|
|
@@ -154,6 +204,63 @@
|
|
|
154
204
|
}
|
|
155
205
|
}
|
|
156
206
|
}
|
|
207
|
+
},
|
|
208
|
+
"400": {
|
|
209
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
210
|
+
"content": {
|
|
211
|
+
"application/json": {
|
|
212
|
+
"schema": {
|
|
213
|
+
"$ref": "#/components/schemas/Error"
|
|
214
|
+
},
|
|
215
|
+
"examples": {
|
|
216
|
+
"exampleResponse": {
|
|
217
|
+
"value": {
|
|
218
|
+
"name": "GeneralError",
|
|
219
|
+
"message": "errorMessage",
|
|
220
|
+
"properties": {
|
|
221
|
+
"foo": "bar"
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
"401": {
|
|
230
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
231
|
+
"content": {
|
|
232
|
+
"application/json": {
|
|
233
|
+
"schema": {
|
|
234
|
+
"$ref": "#/components/schemas/Error"
|
|
235
|
+
},
|
|
236
|
+
"examples": {
|
|
237
|
+
"exampleResponse": {
|
|
238
|
+
"value": {
|
|
239
|
+
"name": "UnauthorizedError",
|
|
240
|
+
"message": "errorMessage"
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
},
|
|
247
|
+
"500": {
|
|
248
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
249
|
+
"content": {
|
|
250
|
+
"application/json": {
|
|
251
|
+
"schema": {
|
|
252
|
+
"$ref": "#/components/schemas/Error"
|
|
253
|
+
},
|
|
254
|
+
"examples": {
|
|
255
|
+
"exampleResponse": {
|
|
256
|
+
"value": {
|
|
257
|
+
"name": "InternalServerError",
|
|
258
|
+
"message": "errorMessage"
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
}
|
|
157
264
|
}
|
|
158
265
|
}
|
|
159
266
|
}
|
|
@@ -194,11 +301,97 @@
|
|
|
194
301
|
],
|
|
195
302
|
"responses": {
|
|
196
303
|
"200": {
|
|
304
|
+
"description": "Get an entry from entity storage.",
|
|
305
|
+
"content": {
|
|
306
|
+
"application/json": {
|
|
307
|
+
"schema": {
|
|
308
|
+
"$ref": "#/components/schemas/EntityStorageGetResponse"
|
|
309
|
+
},
|
|
310
|
+
"examples": {
|
|
311
|
+
"entityStorageGetResponseExample": {
|
|
312
|
+
"value": {
|
|
313
|
+
"id": "12345",
|
|
314
|
+
"name": "My Item"
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
"400": {
|
|
322
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
323
|
+
"content": {
|
|
324
|
+
"application/json": {
|
|
325
|
+
"schema": {
|
|
326
|
+
"$ref": "#/components/schemas/Error"
|
|
327
|
+
},
|
|
328
|
+
"examples": {
|
|
329
|
+
"exampleResponse": {
|
|
330
|
+
"value": {
|
|
331
|
+
"name": "GeneralError",
|
|
332
|
+
"message": "errorMessage",
|
|
333
|
+
"properties": {
|
|
334
|
+
"foo": "bar"
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
"401": {
|
|
343
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
344
|
+
"content": {
|
|
345
|
+
"application/json": {
|
|
346
|
+
"schema": {
|
|
347
|
+
"$ref": "#/components/schemas/Error"
|
|
348
|
+
},
|
|
349
|
+
"examples": {
|
|
350
|
+
"exampleResponse": {
|
|
351
|
+
"value": {
|
|
352
|
+
"name": "UnauthorizedError",
|
|
353
|
+
"message": "errorMessage"
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
"404": {
|
|
197
361
|
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
198
362
|
"content": {
|
|
199
363
|
"application/json": {
|
|
200
364
|
"schema": {
|
|
201
365
|
"$ref": "#/components/schemas/NotFoundResponse"
|
|
366
|
+
},
|
|
367
|
+
"examples": {
|
|
368
|
+
"exampleResponse": {
|
|
369
|
+
"value": {
|
|
370
|
+
"name": "NotFoundError",
|
|
371
|
+
"message": "errorMessage",
|
|
372
|
+
"properties": {
|
|
373
|
+
"notFoundId": "1"
|
|
374
|
+
}
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"500": {
|
|
382
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
383
|
+
"content": {
|
|
384
|
+
"application/json": {
|
|
385
|
+
"schema": {
|
|
386
|
+
"$ref": "#/components/schemas/Error"
|
|
387
|
+
},
|
|
388
|
+
"examples": {
|
|
389
|
+
"exampleResponse": {
|
|
390
|
+
"value": {
|
|
391
|
+
"name": "InternalServerError",
|
|
392
|
+
"message": "errorMessage"
|
|
393
|
+
}
|
|
394
|
+
}
|
|
202
395
|
}
|
|
203
396
|
}
|
|
204
397
|
}
|
|
@@ -230,17 +423,83 @@
|
|
|
230
423
|
}
|
|
231
424
|
],
|
|
232
425
|
"responses": {
|
|
233
|
-
"
|
|
234
|
-
"description": "The
|
|
426
|
+
"204": {
|
|
427
|
+
"description": "The rest request ended in success with no data."
|
|
428
|
+
},
|
|
429
|
+
"400": {
|
|
430
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
235
431
|
"content": {
|
|
236
|
-
"
|
|
432
|
+
"application/json": {
|
|
237
433
|
"schema": {
|
|
238
|
-
"$ref": "#/components/schemas/
|
|
434
|
+
"$ref": "#/components/schemas/Error"
|
|
435
|
+
},
|
|
436
|
+
"examples": {
|
|
437
|
+
"exampleResponse": {
|
|
438
|
+
"value": {
|
|
439
|
+
"name": "GeneralError",
|
|
440
|
+
"message": "errorMessage",
|
|
441
|
+
"properties": {
|
|
442
|
+
"foo": "bar"
|
|
443
|
+
}
|
|
444
|
+
}
|
|
445
|
+
}
|
|
239
446
|
}
|
|
240
|
-
}
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
},
|
|
450
|
+
"401": {
|
|
451
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
452
|
+
"content": {
|
|
453
|
+
"application/json": {
|
|
454
|
+
"schema": {
|
|
455
|
+
"$ref": "#/components/schemas/Error"
|
|
456
|
+
},
|
|
457
|
+
"examples": {
|
|
458
|
+
"exampleResponse": {
|
|
459
|
+
"value": {
|
|
460
|
+
"name": "UnauthorizedError",
|
|
461
|
+
"message": "errorMessage"
|
|
462
|
+
}
|
|
463
|
+
}
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
},
|
|
468
|
+
"404": {
|
|
469
|
+
"description": "The resource you tried to access does not exist, see the content for more details.",
|
|
470
|
+
"content": {
|
|
241
471
|
"application/json": {
|
|
242
472
|
"schema": {
|
|
243
473
|
"$ref": "#/components/schemas/NotFoundResponse"
|
|
474
|
+
},
|
|
475
|
+
"examples": {
|
|
476
|
+
"exampleResponse": {
|
|
477
|
+
"value": {
|
|
478
|
+
"name": "NotFoundError",
|
|
479
|
+
"message": "errorMessage",
|
|
480
|
+
"properties": {
|
|
481
|
+
"notFoundId": "1"
|
|
482
|
+
}
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
}
|
|
486
|
+
}
|
|
487
|
+
}
|
|
488
|
+
},
|
|
489
|
+
"500": {
|
|
490
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
491
|
+
"content": {
|
|
492
|
+
"application/json": {
|
|
493
|
+
"schema": {
|
|
494
|
+
"$ref": "#/components/schemas/Error"
|
|
495
|
+
},
|
|
496
|
+
"examples": {
|
|
497
|
+
"exampleResponse": {
|
|
498
|
+
"value": {
|
|
499
|
+
"name": "InternalServerError",
|
|
500
|
+
"message": "errorMessage"
|
|
501
|
+
}
|
|
502
|
+
}
|
|
244
503
|
}
|
|
245
504
|
}
|
|
246
505
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/entity-storage-service",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.2",
|
|
4
4
|
"description": "Entity Storage contract implementation and REST endpoint definitions",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@twin.org/api-models": "next",
|
|
18
18
|
"@twin.org/core": "next",
|
|
19
19
|
"@twin.org/entity": "next",
|
|
20
|
-
"@twin.org/entity-storage-models": "0.0.3-next.
|
|
20
|
+
"@twin.org/entity-storage-models": "0.0.3-next.2",
|
|
21
21
|
"@twin.org/nameof": "next",
|
|
22
22
|
"@twin.org/web": "next"
|
|
23
23
|
},
|