@ogcio/building-blocks-sdk 0.1.11 → 0.1.13

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.
@@ -236,7 +236,63 @@
236
236
  }
237
237
  }
238
238
  },
239
- "400": {
239
+ "4XX": {
240
+ "description": "Default Response",
241
+ "content": {
242
+ "application/json": {
243
+ "schema": {
244
+ "type": "object",
245
+ "properties": {
246
+ "code": {
247
+ "description": "Code used to categorize the error",
248
+ "type": "string"
249
+ },
250
+ "detail": {
251
+ "description": "Description of the error",
252
+ "type": "string"
253
+ },
254
+ "requestId": {
255
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
256
+ "type": "string"
257
+ },
258
+ "name": {
259
+ "description": "Name of the error type",
260
+ "type": "string"
261
+ },
262
+ "validation": {
263
+ "description": "List of the validation errors",
264
+ "type": "array",
265
+ "items": {
266
+ "type": "object",
267
+ "properties": {
268
+ "fieldName": {
269
+ "type": "string"
270
+ },
271
+ "message": {
272
+ "type": "string"
273
+ }
274
+ },
275
+ "required": [
276
+ "fieldName",
277
+ "message"
278
+ ]
279
+ }
280
+ },
281
+ "validationContext": {
282
+ "type": "string"
283
+ }
284
+ },
285
+ "required": [
286
+ "code",
287
+ "detail",
288
+ "requestId",
289
+ "name"
290
+ ]
291
+ }
292
+ }
293
+ }
294
+ },
295
+ "5XX": {
240
296
  "description": "Default Response",
241
297
  "content": {
242
298
  "application/json": {
@@ -419,13 +475,91 @@
419
475
  "properties": {
420
476
  "id": {
421
477
  "format": "uuid",
422
- "description": "The unique id of the created message",
478
+ "description": "Unique Id of the resource",
423
479
  "type": "string"
424
480
  }
425
481
  },
426
482
  "required": [
427
483
  "id"
428
484
  ]
485
+ },
486
+ "metadata": {
487
+ "type": "object",
488
+ "properties": {
489
+ "links": {
490
+ "description": "Object containing the links to the related endpoints",
491
+ "type": "object",
492
+ "properties": {
493
+ "self": {
494
+ "type": "object",
495
+ "properties": {
496
+ "href": {
497
+ "description": "URL pointing to the request itself",
498
+ "type": "string"
499
+ }
500
+ }
501
+ },
502
+ "next": {
503
+ "type": "object",
504
+ "properties": {
505
+ "href": {
506
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
507
+ "type": "string"
508
+ }
509
+ }
510
+ },
511
+ "prev": {
512
+ "type": "object",
513
+ "properties": {
514
+ "href": {
515
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
516
+ "type": "string"
517
+ }
518
+ }
519
+ },
520
+ "first": {
521
+ "type": "object",
522
+ "properties": {
523
+ "href": {
524
+ "description": "URL pointing to the first page of results in a paginated response",
525
+ "type": "string"
526
+ }
527
+ }
528
+ },
529
+ "last": {
530
+ "type": "object",
531
+ "properties": {
532
+ "href": {
533
+ "description": "URL pointing to the first page of results in a paginated response",
534
+ "type": "string"
535
+ }
536
+ }
537
+ },
538
+ "pages": {
539
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
540
+ "type": "object",
541
+ "additionalProperties": {
542
+ "type": "object",
543
+ "properties": {
544
+ "href": {
545
+ "type": "string"
546
+ }
547
+ }
548
+ }
549
+ }
550
+ },
551
+ "required": [
552
+ "self",
553
+ "first",
554
+ "last",
555
+ "pages"
556
+ ]
557
+ },
558
+ "totalCount": {
559
+ "description": "Number representing the total number of available items",
560
+ "type": "number"
561
+ }
562
+ }
429
563
  }
430
564
  },
431
565
  "required": [
@@ -1282,7 +1416,7 @@
1282
1416
  }
1283
1417
  },
1284
1418
  "responses": {
1285
- "200": {
1419
+ "201": {
1286
1420
  "description": "Default Response",
1287
1421
  "content": {
1288
1422
  "application/json": {
@@ -1300,6 +1434,84 @@
1300
1434
  "required": [
1301
1435
  "id"
1302
1436
  ]
1437
+ },
1438
+ "metadata": {
1439
+ "type": "object",
1440
+ "properties": {
1441
+ "links": {
1442
+ "description": "Object containing the links to the related endpoints",
1443
+ "type": "object",
1444
+ "properties": {
1445
+ "self": {
1446
+ "type": "object",
1447
+ "properties": {
1448
+ "href": {
1449
+ "description": "URL pointing to the request itself",
1450
+ "type": "string"
1451
+ }
1452
+ }
1453
+ },
1454
+ "next": {
1455
+ "type": "object",
1456
+ "properties": {
1457
+ "href": {
1458
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1459
+ "type": "string"
1460
+ }
1461
+ }
1462
+ },
1463
+ "prev": {
1464
+ "type": "object",
1465
+ "properties": {
1466
+ "href": {
1467
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1468
+ "type": "string"
1469
+ }
1470
+ }
1471
+ },
1472
+ "first": {
1473
+ "type": "object",
1474
+ "properties": {
1475
+ "href": {
1476
+ "description": "URL pointing to the first page of results in a paginated response",
1477
+ "type": "string"
1478
+ }
1479
+ }
1480
+ },
1481
+ "last": {
1482
+ "type": "object",
1483
+ "properties": {
1484
+ "href": {
1485
+ "description": "URL pointing to the first page of results in a paginated response",
1486
+ "type": "string"
1487
+ }
1488
+ }
1489
+ },
1490
+ "pages": {
1491
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1492
+ "type": "object",
1493
+ "additionalProperties": {
1494
+ "type": "object",
1495
+ "properties": {
1496
+ "href": {
1497
+ "type": "string"
1498
+ }
1499
+ }
1500
+ }
1501
+ }
1502
+ },
1503
+ "required": [
1504
+ "self",
1505
+ "first",
1506
+ "last",
1507
+ "pages"
1508
+ ]
1509
+ },
1510
+ "totalCount": {
1511
+ "description": "Number representing the total number of available items",
1512
+ "type": "number"
1513
+ }
1514
+ }
1303
1515
  }
1304
1516
  },
1305
1517
  "required": [
@@ -1451,8 +1663,7 @@
1451
1663
  },
1452
1664
  "in": "path",
1453
1665
  "name": "providerId",
1454
- "required": true,
1455
- "description": "The unique id of the requested provider"
1666
+ "required": true
1456
1667
  }
1457
1668
  ],
1458
1669
  "responses": {
@@ -1951,7 +2162,109 @@
1951
2162
  ],
1952
2163
  "responses": {
1953
2164
  "200": {
1954
- "description": "Default Response"
2165
+ "description": "Default Response",
2166
+ "content": {
2167
+ "application/json": {
2168
+ "schema": {
2169
+ "type": "object",
2170
+ "properties": {
2171
+ "data": {
2172
+ "type": "object",
2173
+ "properties": {
2174
+ "id": {
2175
+ "format": "uuid",
2176
+ "type": "string"
2177
+ }
2178
+ },
2179
+ "required": [
2180
+ "id"
2181
+ ]
2182
+ },
2183
+ "metadata": {
2184
+ "type": "object",
2185
+ "properties": {
2186
+ "links": {
2187
+ "description": "Object containing the links to the related endpoints",
2188
+ "type": "object",
2189
+ "properties": {
2190
+ "self": {
2191
+ "type": "object",
2192
+ "properties": {
2193
+ "href": {
2194
+ "description": "URL pointing to the request itself",
2195
+ "type": "string"
2196
+ }
2197
+ }
2198
+ },
2199
+ "next": {
2200
+ "type": "object",
2201
+ "properties": {
2202
+ "href": {
2203
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2204
+ "type": "string"
2205
+ }
2206
+ }
2207
+ },
2208
+ "prev": {
2209
+ "type": "object",
2210
+ "properties": {
2211
+ "href": {
2212
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2213
+ "type": "string"
2214
+ }
2215
+ }
2216
+ },
2217
+ "first": {
2218
+ "type": "object",
2219
+ "properties": {
2220
+ "href": {
2221
+ "description": "URL pointing to the first page of results in a paginated response",
2222
+ "type": "string"
2223
+ }
2224
+ }
2225
+ },
2226
+ "last": {
2227
+ "type": "object",
2228
+ "properties": {
2229
+ "href": {
2230
+ "description": "URL pointing to the first page of results in a paginated response",
2231
+ "type": "string"
2232
+ }
2233
+ }
2234
+ },
2235
+ "pages": {
2236
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2237
+ "type": "object",
2238
+ "additionalProperties": {
2239
+ "type": "object",
2240
+ "properties": {
2241
+ "href": {
2242
+ "type": "string"
2243
+ }
2244
+ }
2245
+ }
2246
+ }
2247
+ },
2248
+ "required": [
2249
+ "self",
2250
+ "first",
2251
+ "last",
2252
+ "pages"
2253
+ ]
2254
+ },
2255
+ "totalCount": {
2256
+ "description": "Number representing the total number of available items",
2257
+ "type": "number"
2258
+ }
2259
+ }
2260
+ }
2261
+ },
2262
+ "required": [
2263
+ "data"
2264
+ ]
2265
+ }
2266
+ }
2267
+ }
1955
2268
  },
1956
2269
  "5XX": {
1957
2270
  "description": "Default Response",
@@ -2080,13 +2393,114 @@
2080
2393
  },
2081
2394
  "in": "path",
2082
2395
  "name": "providerId",
2083
- "required": true,
2084
- "description": "Unique id of the provider to be deleted"
2396
+ "required": true
2085
2397
  }
2086
2398
  ],
2087
2399
  "responses": {
2088
2400
  "200": {
2089
- "description": "Default Response"
2401
+ "description": "Default Response",
2402
+ "content": {
2403
+ "application/json": {
2404
+ "schema": {
2405
+ "type": "object",
2406
+ "properties": {
2407
+ "data": {
2408
+ "type": "object",
2409
+ "properties": {
2410
+ "id": {
2411
+ "format": "uuid",
2412
+ "type": "string"
2413
+ }
2414
+ },
2415
+ "required": [
2416
+ "id"
2417
+ ]
2418
+ },
2419
+ "metadata": {
2420
+ "type": "object",
2421
+ "properties": {
2422
+ "links": {
2423
+ "description": "Object containing the links to the related endpoints",
2424
+ "type": "object",
2425
+ "properties": {
2426
+ "self": {
2427
+ "type": "object",
2428
+ "properties": {
2429
+ "href": {
2430
+ "description": "URL pointing to the request itself",
2431
+ "type": "string"
2432
+ }
2433
+ }
2434
+ },
2435
+ "next": {
2436
+ "type": "object",
2437
+ "properties": {
2438
+ "href": {
2439
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2440
+ "type": "string"
2441
+ }
2442
+ }
2443
+ },
2444
+ "prev": {
2445
+ "type": "object",
2446
+ "properties": {
2447
+ "href": {
2448
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2449
+ "type": "string"
2450
+ }
2451
+ }
2452
+ },
2453
+ "first": {
2454
+ "type": "object",
2455
+ "properties": {
2456
+ "href": {
2457
+ "description": "URL pointing to the first page of results in a paginated response",
2458
+ "type": "string"
2459
+ }
2460
+ }
2461
+ },
2462
+ "last": {
2463
+ "type": "object",
2464
+ "properties": {
2465
+ "href": {
2466
+ "description": "URL pointing to the first page of results in a paginated response",
2467
+ "type": "string"
2468
+ }
2469
+ }
2470
+ },
2471
+ "pages": {
2472
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2473
+ "type": "object",
2474
+ "additionalProperties": {
2475
+ "type": "object",
2476
+ "properties": {
2477
+ "href": {
2478
+ "type": "string"
2479
+ }
2480
+ }
2481
+ }
2482
+ }
2483
+ },
2484
+ "required": [
2485
+ "self",
2486
+ "first",
2487
+ "last",
2488
+ "pages"
2489
+ ]
2490
+ },
2491
+ "totalCount": {
2492
+ "description": "Number representing the total number of available items",
2493
+ "type": "number"
2494
+ }
2495
+ }
2496
+ }
2497
+ },
2498
+ "required": [
2499
+ "data"
2500
+ ]
2501
+ }
2502
+ }
2503
+ }
2090
2504
  },
2091
2505
  "5XX": {
2092
2506
  "description": "Default Response",
@@ -2582,13 +2996,90 @@
2582
2996
  "properties": {
2583
2997
  "id": {
2584
2998
  "format": "uuid",
2585
- "description": "Unique id of the created message",
2586
2999
  "type": "string"
2587
3000
  }
2588
- },
2589
- "required": [
2590
- "id"
2591
- ]
3001
+ },
3002
+ "required": [
3003
+ "id"
3004
+ ]
3005
+ },
3006
+ "metadata": {
3007
+ "type": "object",
3008
+ "properties": {
3009
+ "links": {
3010
+ "description": "Object containing the links to the related endpoints",
3011
+ "type": "object",
3012
+ "properties": {
3013
+ "self": {
3014
+ "type": "object",
3015
+ "properties": {
3016
+ "href": {
3017
+ "description": "URL pointing to the request itself",
3018
+ "type": "string"
3019
+ }
3020
+ }
3021
+ },
3022
+ "next": {
3023
+ "type": "object",
3024
+ "properties": {
3025
+ "href": {
3026
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
3027
+ "type": "string"
3028
+ }
3029
+ }
3030
+ },
3031
+ "prev": {
3032
+ "type": "object",
3033
+ "properties": {
3034
+ "href": {
3035
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
3036
+ "type": "string"
3037
+ }
3038
+ }
3039
+ },
3040
+ "first": {
3041
+ "type": "object",
3042
+ "properties": {
3043
+ "href": {
3044
+ "description": "URL pointing to the first page of results in a paginated response",
3045
+ "type": "string"
3046
+ }
3047
+ }
3048
+ },
3049
+ "last": {
3050
+ "type": "object",
3051
+ "properties": {
3052
+ "href": {
3053
+ "description": "URL pointing to the first page of results in a paginated response",
3054
+ "type": "string"
3055
+ }
3056
+ }
3057
+ },
3058
+ "pages": {
3059
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
3060
+ "type": "object",
3061
+ "additionalProperties": {
3062
+ "type": "object",
3063
+ "properties": {
3064
+ "href": {
3065
+ "type": "string"
3066
+ }
3067
+ }
3068
+ }
3069
+ }
3070
+ },
3071
+ "required": [
3072
+ "self",
3073
+ "first",
3074
+ "last",
3075
+ "pages"
3076
+ ]
3077
+ },
3078
+ "totalCount": {
3079
+ "description": "Number representing the total number of available items",
3080
+ "type": "number"
3081
+ }
3082
+ }
2592
3083
  }
2593
3084
  },
2594
3085
  "required": [
@@ -3116,7 +3607,109 @@
3116
3607
  ],
3117
3608
  "responses": {
3118
3609
  "200": {
3119
- "description": "Default Response"
3610
+ "description": "Default Response",
3611
+ "content": {
3612
+ "application/json": {
3613
+ "schema": {
3614
+ "type": "object",
3615
+ "properties": {
3616
+ "data": {
3617
+ "type": "object",
3618
+ "properties": {
3619
+ "id": {
3620
+ "format": "uuid",
3621
+ "type": "string"
3622
+ }
3623
+ },
3624
+ "required": [
3625
+ "id"
3626
+ ]
3627
+ },
3628
+ "metadata": {
3629
+ "type": "object",
3630
+ "properties": {
3631
+ "links": {
3632
+ "description": "Object containing the links to the related endpoints",
3633
+ "type": "object",
3634
+ "properties": {
3635
+ "self": {
3636
+ "type": "object",
3637
+ "properties": {
3638
+ "href": {
3639
+ "description": "URL pointing to the request itself",
3640
+ "type": "string"
3641
+ }
3642
+ }
3643
+ },
3644
+ "next": {
3645
+ "type": "object",
3646
+ "properties": {
3647
+ "href": {
3648
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
3649
+ "type": "string"
3650
+ }
3651
+ }
3652
+ },
3653
+ "prev": {
3654
+ "type": "object",
3655
+ "properties": {
3656
+ "href": {
3657
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
3658
+ "type": "string"
3659
+ }
3660
+ }
3661
+ },
3662
+ "first": {
3663
+ "type": "object",
3664
+ "properties": {
3665
+ "href": {
3666
+ "description": "URL pointing to the first page of results in a paginated response",
3667
+ "type": "string"
3668
+ }
3669
+ }
3670
+ },
3671
+ "last": {
3672
+ "type": "object",
3673
+ "properties": {
3674
+ "href": {
3675
+ "description": "URL pointing to the first page of results in a paginated response",
3676
+ "type": "string"
3677
+ }
3678
+ }
3679
+ },
3680
+ "pages": {
3681
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
3682
+ "type": "object",
3683
+ "additionalProperties": {
3684
+ "type": "object",
3685
+ "properties": {
3686
+ "href": {
3687
+ "type": "string"
3688
+ }
3689
+ }
3690
+ }
3691
+ }
3692
+ },
3693
+ "required": [
3694
+ "self",
3695
+ "first",
3696
+ "last",
3697
+ "pages"
3698
+ ]
3699
+ },
3700
+ "totalCount": {
3701
+ "description": "Number representing the total number of available items",
3702
+ "type": "number"
3703
+ }
3704
+ }
3705
+ }
3706
+ },
3707
+ "required": [
3708
+ "data"
3709
+ ]
3710
+ }
3711
+ }
3712
+ }
3120
3713
  },
3121
3714
  "4XX": {
3122
3715
  "description": "Default Response",
@@ -3250,7 +3843,109 @@
3250
3843
  ],
3251
3844
  "responses": {
3252
3845
  "200": {
3253
- "description": "Default Response"
3846
+ "description": "Default Response",
3847
+ "content": {
3848
+ "application/json": {
3849
+ "schema": {
3850
+ "type": "object",
3851
+ "properties": {
3852
+ "data": {
3853
+ "type": "object",
3854
+ "properties": {
3855
+ "id": {
3856
+ "format": "uuid",
3857
+ "type": "string"
3858
+ }
3859
+ },
3860
+ "required": [
3861
+ "id"
3862
+ ]
3863
+ },
3864
+ "metadata": {
3865
+ "type": "object",
3866
+ "properties": {
3867
+ "links": {
3868
+ "description": "Object containing the links to the related endpoints",
3869
+ "type": "object",
3870
+ "properties": {
3871
+ "self": {
3872
+ "type": "object",
3873
+ "properties": {
3874
+ "href": {
3875
+ "description": "URL pointing to the request itself",
3876
+ "type": "string"
3877
+ }
3878
+ }
3879
+ },
3880
+ "next": {
3881
+ "type": "object",
3882
+ "properties": {
3883
+ "href": {
3884
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
3885
+ "type": "string"
3886
+ }
3887
+ }
3888
+ },
3889
+ "prev": {
3890
+ "type": "object",
3891
+ "properties": {
3892
+ "href": {
3893
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
3894
+ "type": "string"
3895
+ }
3896
+ }
3897
+ },
3898
+ "first": {
3899
+ "type": "object",
3900
+ "properties": {
3901
+ "href": {
3902
+ "description": "URL pointing to the first page of results in a paginated response",
3903
+ "type": "string"
3904
+ }
3905
+ }
3906
+ },
3907
+ "last": {
3908
+ "type": "object",
3909
+ "properties": {
3910
+ "href": {
3911
+ "description": "URL pointing to the first page of results in a paginated response",
3912
+ "type": "string"
3913
+ }
3914
+ }
3915
+ },
3916
+ "pages": {
3917
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
3918
+ "type": "object",
3919
+ "additionalProperties": {
3920
+ "type": "object",
3921
+ "properties": {
3922
+ "href": {
3923
+ "type": "string"
3924
+ }
3925
+ }
3926
+ }
3927
+ }
3928
+ },
3929
+ "required": [
3930
+ "self",
3931
+ "first",
3932
+ "last",
3933
+ "pages"
3934
+ ]
3935
+ },
3936
+ "totalCount": {
3937
+ "description": "Number representing the total number of available items",
3938
+ "type": "number"
3939
+ }
3940
+ }
3941
+ }
3942
+ },
3943
+ "required": [
3944
+ "data"
3945
+ ]
3946
+ }
3947
+ }
3948
+ }
3254
3949
  },
3255
3950
  "4XX": {
3256
3951
  "description": "Default Response",
@@ -7766,10 +8461,11 @@
7766
8461
  "tags": [
7767
8462
  "Message events"
7768
8463
  ],
7769
- "description": "Returns the selected event id",
8464
+ "description": "Returns the selected event",
7770
8465
  "parameters": [
7771
8466
  {
7772
8467
  "schema": {
8468
+ "format": "uuid",
7773
8469
  "type": "string"
7774
8470
  },
7775
8471
  "in": "path",
@@ -8074,7 +8770,7 @@
8074
8770
  }
8075
8771
  }
8076
8772
  },
8077
- "/api/v1/jobs/{id}": {
8773
+ "/api/v1/jobs/{jobId}": {
8078
8774
  "post": {
8079
8775
  "tags": [
8080
8776
  "Jobs"
@@ -8102,10 +8798,11 @@
8102
8798
  "parameters": [
8103
8799
  {
8104
8800
  "schema": {
8801
+ "format": "uuid",
8105
8802
  "type": "string"
8106
8803
  },
8107
8804
  "in": "path",
8108
- "name": "id",
8805
+ "name": "jobId",
8109
8806
  "required": true
8110
8807
  }
8111
8808
  ],
@@ -8259,6 +8956,7 @@
8259
8956
  "parameters": [
8260
8957
  {
8261
8958
  "schema": {
8959
+ "format": "uuid",
8262
8960
  "type": "string"
8263
8961
  },
8264
8962
  "in": "path",