@ogcio/building-blocks-sdk 0.2.49 → 0.2.51

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.
@@ -16,6 +16,1319 @@
16
16
  "schemas": {}
17
17
  },
18
18
  "paths": {
19
+ "/api/v1/citizens/consent-statements/latest": {
20
+ "get": {
21
+ "operationId": "citizenLatestStatement",
22
+ "tags": [
23
+ "CitizenConsentPolicies"
24
+ ],
25
+ "description": "Get the latest statement for a subject",
26
+ "parameters": [
27
+ {
28
+ "schema": {
29
+ "maxLength": 50,
30
+ "type": "string"
31
+ },
32
+ "in": "query",
33
+ "name": "subject",
34
+ "required": true
35
+ }
36
+ ],
37
+ "responses": {
38
+ "200": {
39
+ "description": "Default Response",
40
+ "content": {
41
+ "application/json": {
42
+ "schema": {
43
+ "type": "object",
44
+ "properties": {
45
+ "data": {
46
+ "type": "object",
47
+ "allOf": [
48
+ {
49
+ "type": "object",
50
+ "properties": {
51
+ "id": {
52
+ "format": "uuid",
53
+ "type": "string"
54
+ },
55
+ "subject": {
56
+ "maxLength": 50,
57
+ "type": "string"
58
+ },
59
+ "version": {
60
+ "type": "integer"
61
+ },
62
+ "createdAt": {
63
+ "format": "date-time",
64
+ "type": "string"
65
+ }
66
+ },
67
+ "required": [
68
+ "id",
69
+ "subject",
70
+ "version",
71
+ "createdAt"
72
+ ]
73
+ },
74
+ {
75
+ "type": "object",
76
+ "properties": {
77
+ "translations": {
78
+ "type": "object",
79
+ "properties": {
80
+ "en": {
81
+ "type": "object",
82
+ "properties": {
83
+ "id": {
84
+ "format": "uuid",
85
+ "type": "string"
86
+ },
87
+ "consentStatementId": {
88
+ "format": "uuid",
89
+ "type": "string"
90
+ },
91
+ "language": {
92
+ "anyOf": [
93
+ {
94
+ "type": "string",
95
+ "enum": [
96
+ "en"
97
+ ]
98
+ },
99
+ {
100
+ "type": "string",
101
+ "enum": [
102
+ "ga"
103
+ ]
104
+ }
105
+ ]
106
+ },
107
+ "bodyTop": {
108
+ "type": "array",
109
+ "items": {
110
+ "type": "string"
111
+ }
112
+ },
113
+ "bodyList": {
114
+ "type": "array",
115
+ "items": {
116
+ "type": "string"
117
+ }
118
+ },
119
+ "bodyBottom": {
120
+ "type": "array",
121
+ "items": {
122
+ "type": "string"
123
+ }
124
+ },
125
+ "bodySmall": {
126
+ "type": "array",
127
+ "items": {
128
+ "type": "string"
129
+ }
130
+ },
131
+ "bodyLinks": {
132
+ "type": "object",
133
+ "additionalProperties": {
134
+ "type": "string"
135
+ }
136
+ },
137
+ "bodyFooter": {
138
+ "anyOf": [
139
+ {
140
+ "type": "string"
141
+ },
142
+ {
143
+ "type": "null"
144
+ }
145
+ ]
146
+ },
147
+ "title": {
148
+ "type": "string"
149
+ },
150
+ "createdAt": {
151
+ "format": "date-time",
152
+ "type": "string"
153
+ }
154
+ },
155
+ "required": [
156
+ "id",
157
+ "consentStatementId",
158
+ "language",
159
+ "bodyTop",
160
+ "bodyList",
161
+ "bodyBottom",
162
+ "bodySmall",
163
+ "bodyLinks",
164
+ "bodyFooter",
165
+ "title",
166
+ "createdAt"
167
+ ]
168
+ },
169
+ "ga": {
170
+ "type": "object",
171
+ "properties": {
172
+ "id": {
173
+ "format": "uuid",
174
+ "type": "string"
175
+ },
176
+ "consentStatementId": {
177
+ "format": "uuid",
178
+ "type": "string"
179
+ },
180
+ "language": {
181
+ "anyOf": [
182
+ {
183
+ "type": "string",
184
+ "enum": [
185
+ "en"
186
+ ]
187
+ },
188
+ {
189
+ "type": "string",
190
+ "enum": [
191
+ "ga"
192
+ ]
193
+ }
194
+ ]
195
+ },
196
+ "bodyTop": {
197
+ "type": "array",
198
+ "items": {
199
+ "type": "string"
200
+ }
201
+ },
202
+ "bodyList": {
203
+ "type": "array",
204
+ "items": {
205
+ "type": "string"
206
+ }
207
+ },
208
+ "bodyBottom": {
209
+ "type": "array",
210
+ "items": {
211
+ "type": "string"
212
+ }
213
+ },
214
+ "bodySmall": {
215
+ "type": "array",
216
+ "items": {
217
+ "type": "string"
218
+ }
219
+ },
220
+ "bodyLinks": {
221
+ "type": "object",
222
+ "additionalProperties": {
223
+ "type": "string"
224
+ }
225
+ },
226
+ "bodyFooter": {
227
+ "anyOf": [
228
+ {
229
+ "type": "string"
230
+ },
231
+ {
232
+ "type": "null"
233
+ }
234
+ ]
235
+ },
236
+ "title": {
237
+ "type": "string"
238
+ },
239
+ "createdAt": {
240
+ "format": "date-time",
241
+ "type": "string"
242
+ }
243
+ },
244
+ "required": [
245
+ "id",
246
+ "consentStatementId",
247
+ "language",
248
+ "bodyTop",
249
+ "bodyList",
250
+ "bodyBottom",
251
+ "bodySmall",
252
+ "bodyLinks",
253
+ "bodyFooter",
254
+ "title",
255
+ "createdAt"
256
+ ]
257
+ }
258
+ },
259
+ "required": [
260
+ "en",
261
+ "ga"
262
+ ]
263
+ }
264
+ },
265
+ "required": [
266
+ "translations"
267
+ ]
268
+ }
269
+ ]
270
+ },
271
+ "metadata": {
272
+ "type": "object",
273
+ "properties": {
274
+ "links": {
275
+ "description": "Object containing the links to the related endpoints",
276
+ "type": "object",
277
+ "properties": {
278
+ "self": {
279
+ "type": "object",
280
+ "properties": {
281
+ "href": {
282
+ "description": "URL pointing to the request itself",
283
+ "type": "string"
284
+ }
285
+ }
286
+ },
287
+ "next": {
288
+ "type": "object",
289
+ "properties": {
290
+ "href": {
291
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
292
+ "type": "string"
293
+ }
294
+ }
295
+ },
296
+ "prev": {
297
+ "type": "object",
298
+ "properties": {
299
+ "href": {
300
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
301
+ "type": "string"
302
+ }
303
+ }
304
+ },
305
+ "first": {
306
+ "type": "object",
307
+ "properties": {
308
+ "href": {
309
+ "description": "URL pointing to the first page of results in a paginated response",
310
+ "type": "string"
311
+ }
312
+ }
313
+ },
314
+ "last": {
315
+ "type": "object",
316
+ "properties": {
317
+ "href": {
318
+ "description": "URL pointing to the first page of results in a paginated response",
319
+ "type": "string"
320
+ }
321
+ }
322
+ },
323
+ "pages": {
324
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
325
+ "type": "object",
326
+ "additionalProperties": {
327
+ "type": "object",
328
+ "properties": {
329
+ "href": {
330
+ "type": "string"
331
+ }
332
+ }
333
+ }
334
+ }
335
+ },
336
+ "required": [
337
+ "self",
338
+ "first",
339
+ "last",
340
+ "pages"
341
+ ]
342
+ },
343
+ "totalCount": {
344
+ "description": "Number representing the total number of available items",
345
+ "type": "number"
346
+ }
347
+ }
348
+ }
349
+ },
350
+ "required": [
351
+ "data"
352
+ ]
353
+ }
354
+ }
355
+ }
356
+ },
357
+ "4XX": {
358
+ "description": "Default Response",
359
+ "content": {
360
+ "application/json": {
361
+ "schema": {
362
+ "type": "object",
363
+ "properties": {
364
+ "code": {
365
+ "description": "Code used to categorize the error",
366
+ "type": "string"
367
+ },
368
+ "detail": {
369
+ "description": "Description of the error",
370
+ "type": "string"
371
+ },
372
+ "requestId": {
373
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
374
+ "type": "string"
375
+ },
376
+ "name": {
377
+ "description": "Name of the error type",
378
+ "type": "string"
379
+ },
380
+ "validation": {
381
+ "description": "List of the validation errors",
382
+ "type": "array",
383
+ "items": {
384
+ "type": "object",
385
+ "properties": {
386
+ "fieldName": {
387
+ "type": "string"
388
+ },
389
+ "message": {
390
+ "type": "string"
391
+ }
392
+ },
393
+ "required": [
394
+ "fieldName",
395
+ "message"
396
+ ]
397
+ }
398
+ },
399
+ "validationContext": {
400
+ "type": "string"
401
+ },
402
+ "statusCode": {
403
+ "type": "number"
404
+ }
405
+ },
406
+ "required": [
407
+ "code",
408
+ "detail",
409
+ "requestId",
410
+ "name",
411
+ "statusCode"
412
+ ]
413
+ }
414
+ }
415
+ }
416
+ },
417
+ "5XX": {
418
+ "description": "Default Response",
419
+ "content": {
420
+ "application/json": {
421
+ "schema": {
422
+ "type": "object",
423
+ "properties": {
424
+ "code": {
425
+ "description": "Code used to categorize the error",
426
+ "type": "string"
427
+ },
428
+ "detail": {
429
+ "description": "Description of the error",
430
+ "type": "string"
431
+ },
432
+ "requestId": {
433
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
434
+ "type": "string"
435
+ },
436
+ "name": {
437
+ "description": "Name of the error type",
438
+ "type": "string"
439
+ },
440
+ "validation": {
441
+ "description": "List of the validation errors",
442
+ "type": "array",
443
+ "items": {
444
+ "type": "object",
445
+ "properties": {
446
+ "fieldName": {
447
+ "type": "string"
448
+ },
449
+ "message": {
450
+ "type": "string"
451
+ }
452
+ },
453
+ "required": [
454
+ "fieldName",
455
+ "message"
456
+ ]
457
+ }
458
+ },
459
+ "validationContext": {
460
+ "type": "string"
461
+ },
462
+ "statusCode": {
463
+ "type": "number"
464
+ }
465
+ },
466
+ "required": [
467
+ "code",
468
+ "detail",
469
+ "requestId",
470
+ "name",
471
+ "statusCode"
472
+ ]
473
+ }
474
+ }
475
+ }
476
+ }
477
+ }
478
+ }
479
+ },
480
+ "/api/v1/organisations/consent-statements/latest": {
481
+ "get": {
482
+ "operationId": "organizationLatestStatement",
483
+ "tags": [
484
+ "OrganisationConsentPolicies"
485
+ ],
486
+ "description": "Get the latest Statement for a subject",
487
+ "parameters": [
488
+ {
489
+ "schema": {
490
+ "maxLength": 50,
491
+ "type": "string"
492
+ },
493
+ "in": "query",
494
+ "name": "subject",
495
+ "required": true
496
+ }
497
+ ],
498
+ "responses": {
499
+ "200": {
500
+ "description": "Default Response",
501
+ "content": {
502
+ "application/json": {
503
+ "schema": {
504
+ "type": "object",
505
+ "properties": {
506
+ "data": {
507
+ "type": "object",
508
+ "allOf": [
509
+ {
510
+ "type": "object",
511
+ "properties": {
512
+ "id": {
513
+ "format": "uuid",
514
+ "type": "string"
515
+ },
516
+ "subject": {
517
+ "maxLength": 50,
518
+ "type": "string"
519
+ },
520
+ "version": {
521
+ "type": "integer"
522
+ },
523
+ "createdAt": {
524
+ "format": "date-time",
525
+ "type": "string"
526
+ }
527
+ },
528
+ "required": [
529
+ "id",
530
+ "subject",
531
+ "version",
532
+ "createdAt"
533
+ ]
534
+ },
535
+ {
536
+ "type": "object",
537
+ "properties": {
538
+ "translations": {
539
+ "type": "object",
540
+ "properties": {
541
+ "en": {
542
+ "type": "object",
543
+ "properties": {
544
+ "id": {
545
+ "format": "uuid",
546
+ "type": "string"
547
+ },
548
+ "consentStatementId": {
549
+ "format": "uuid",
550
+ "type": "string"
551
+ },
552
+ "language": {
553
+ "anyOf": [
554
+ {
555
+ "type": "string",
556
+ "enum": [
557
+ "en"
558
+ ]
559
+ },
560
+ {
561
+ "type": "string",
562
+ "enum": [
563
+ "ga"
564
+ ]
565
+ }
566
+ ]
567
+ },
568
+ "bodyTop": {
569
+ "type": "array",
570
+ "items": {
571
+ "type": "string"
572
+ }
573
+ },
574
+ "bodyList": {
575
+ "type": "array",
576
+ "items": {
577
+ "type": "string"
578
+ }
579
+ },
580
+ "bodyBottom": {
581
+ "type": "array",
582
+ "items": {
583
+ "type": "string"
584
+ }
585
+ },
586
+ "bodySmall": {
587
+ "type": "array",
588
+ "items": {
589
+ "type": "string"
590
+ }
591
+ },
592
+ "bodyLinks": {
593
+ "type": "object",
594
+ "additionalProperties": {
595
+ "type": "string"
596
+ }
597
+ },
598
+ "bodyFooter": {
599
+ "anyOf": [
600
+ {
601
+ "type": "string"
602
+ },
603
+ {
604
+ "type": "null"
605
+ }
606
+ ]
607
+ },
608
+ "title": {
609
+ "type": "string"
610
+ },
611
+ "createdAt": {
612
+ "format": "date-time",
613
+ "type": "string"
614
+ }
615
+ },
616
+ "required": [
617
+ "id",
618
+ "consentStatementId",
619
+ "language",
620
+ "bodyTop",
621
+ "bodyList",
622
+ "bodyBottom",
623
+ "bodySmall",
624
+ "bodyLinks",
625
+ "bodyFooter",
626
+ "title",
627
+ "createdAt"
628
+ ]
629
+ },
630
+ "ga": {
631
+ "type": "object",
632
+ "properties": {
633
+ "id": {
634
+ "format": "uuid",
635
+ "type": "string"
636
+ },
637
+ "consentStatementId": {
638
+ "format": "uuid",
639
+ "type": "string"
640
+ },
641
+ "language": {
642
+ "anyOf": [
643
+ {
644
+ "type": "string",
645
+ "enum": [
646
+ "en"
647
+ ]
648
+ },
649
+ {
650
+ "type": "string",
651
+ "enum": [
652
+ "ga"
653
+ ]
654
+ }
655
+ ]
656
+ },
657
+ "bodyTop": {
658
+ "type": "array",
659
+ "items": {
660
+ "type": "string"
661
+ }
662
+ },
663
+ "bodyList": {
664
+ "type": "array",
665
+ "items": {
666
+ "type": "string"
667
+ }
668
+ },
669
+ "bodyBottom": {
670
+ "type": "array",
671
+ "items": {
672
+ "type": "string"
673
+ }
674
+ },
675
+ "bodySmall": {
676
+ "type": "array",
677
+ "items": {
678
+ "type": "string"
679
+ }
680
+ },
681
+ "bodyLinks": {
682
+ "type": "object",
683
+ "additionalProperties": {
684
+ "type": "string"
685
+ }
686
+ },
687
+ "bodyFooter": {
688
+ "anyOf": [
689
+ {
690
+ "type": "string"
691
+ },
692
+ {
693
+ "type": "null"
694
+ }
695
+ ]
696
+ },
697
+ "title": {
698
+ "type": "string"
699
+ },
700
+ "createdAt": {
701
+ "format": "date-time",
702
+ "type": "string"
703
+ }
704
+ },
705
+ "required": [
706
+ "id",
707
+ "consentStatementId",
708
+ "language",
709
+ "bodyTop",
710
+ "bodyList",
711
+ "bodyBottom",
712
+ "bodySmall",
713
+ "bodyLinks",
714
+ "bodyFooter",
715
+ "title",
716
+ "createdAt"
717
+ ]
718
+ }
719
+ },
720
+ "required": [
721
+ "en",
722
+ "ga"
723
+ ]
724
+ }
725
+ },
726
+ "required": [
727
+ "translations"
728
+ ]
729
+ }
730
+ ]
731
+ },
732
+ "metadata": {
733
+ "type": "object",
734
+ "properties": {
735
+ "links": {
736
+ "description": "Object containing the links to the related endpoints",
737
+ "type": "object",
738
+ "properties": {
739
+ "self": {
740
+ "type": "object",
741
+ "properties": {
742
+ "href": {
743
+ "description": "URL pointing to the request itself",
744
+ "type": "string"
745
+ }
746
+ }
747
+ },
748
+ "next": {
749
+ "type": "object",
750
+ "properties": {
751
+ "href": {
752
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
753
+ "type": "string"
754
+ }
755
+ }
756
+ },
757
+ "prev": {
758
+ "type": "object",
759
+ "properties": {
760
+ "href": {
761
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
762
+ "type": "string"
763
+ }
764
+ }
765
+ },
766
+ "first": {
767
+ "type": "object",
768
+ "properties": {
769
+ "href": {
770
+ "description": "URL pointing to the first page of results in a paginated response",
771
+ "type": "string"
772
+ }
773
+ }
774
+ },
775
+ "last": {
776
+ "type": "object",
777
+ "properties": {
778
+ "href": {
779
+ "description": "URL pointing to the first page of results in a paginated response",
780
+ "type": "string"
781
+ }
782
+ }
783
+ },
784
+ "pages": {
785
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
786
+ "type": "object",
787
+ "additionalProperties": {
788
+ "type": "object",
789
+ "properties": {
790
+ "href": {
791
+ "type": "string"
792
+ }
793
+ }
794
+ }
795
+ }
796
+ },
797
+ "required": [
798
+ "self",
799
+ "first",
800
+ "last",
801
+ "pages"
802
+ ]
803
+ },
804
+ "totalCount": {
805
+ "description": "Number representing the total number of available items",
806
+ "type": "number"
807
+ }
808
+ }
809
+ }
810
+ },
811
+ "required": [
812
+ "data"
813
+ ]
814
+ }
815
+ }
816
+ }
817
+ },
818
+ "4XX": {
819
+ "description": "Default Response",
820
+ "content": {
821
+ "application/json": {
822
+ "schema": {
823
+ "type": "object",
824
+ "properties": {
825
+ "code": {
826
+ "description": "Code used to categorize the error",
827
+ "type": "string"
828
+ },
829
+ "detail": {
830
+ "description": "Description of the error",
831
+ "type": "string"
832
+ },
833
+ "requestId": {
834
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
835
+ "type": "string"
836
+ },
837
+ "name": {
838
+ "description": "Name of the error type",
839
+ "type": "string"
840
+ },
841
+ "validation": {
842
+ "description": "List of the validation errors",
843
+ "type": "array",
844
+ "items": {
845
+ "type": "object",
846
+ "properties": {
847
+ "fieldName": {
848
+ "type": "string"
849
+ },
850
+ "message": {
851
+ "type": "string"
852
+ }
853
+ },
854
+ "required": [
855
+ "fieldName",
856
+ "message"
857
+ ]
858
+ }
859
+ },
860
+ "validationContext": {
861
+ "type": "string"
862
+ },
863
+ "statusCode": {
864
+ "type": "number"
865
+ }
866
+ },
867
+ "required": [
868
+ "code",
869
+ "detail",
870
+ "requestId",
871
+ "name",
872
+ "statusCode"
873
+ ]
874
+ }
875
+ }
876
+ }
877
+ },
878
+ "5XX": {
879
+ "description": "Default Response",
880
+ "content": {
881
+ "application/json": {
882
+ "schema": {
883
+ "type": "object",
884
+ "properties": {
885
+ "code": {
886
+ "description": "Code used to categorize the error",
887
+ "type": "string"
888
+ },
889
+ "detail": {
890
+ "description": "Description of the error",
891
+ "type": "string"
892
+ },
893
+ "requestId": {
894
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
895
+ "type": "string"
896
+ },
897
+ "name": {
898
+ "description": "Name of the error type",
899
+ "type": "string"
900
+ },
901
+ "validation": {
902
+ "description": "List of the validation errors",
903
+ "type": "array",
904
+ "items": {
905
+ "type": "object",
906
+ "properties": {
907
+ "fieldName": {
908
+ "type": "string"
909
+ },
910
+ "message": {
911
+ "type": "string"
912
+ }
913
+ },
914
+ "required": [
915
+ "fieldName",
916
+ "message"
917
+ ]
918
+ }
919
+ },
920
+ "validationContext": {
921
+ "type": "string"
922
+ },
923
+ "statusCode": {
924
+ "type": "number"
925
+ }
926
+ },
927
+ "required": [
928
+ "code",
929
+ "detail",
930
+ "requestId",
931
+ "name",
932
+ "statusCode"
933
+ ]
934
+ }
935
+ }
936
+ }
937
+ }
938
+ }
939
+ }
940
+ },
941
+ "/api/v1/organisations/consent-statements/": {
942
+ "post": {
943
+ "operationId": "organizationCreateStatement",
944
+ "tags": [
945
+ "OrganisationConsentPolicies"
946
+ ],
947
+ "description": "Create Statement for a subject",
948
+ "requestBody": {
949
+ "content": {
950
+ "application/json": {
951
+ "schema": {
952
+ "type": "object",
953
+ "properties": {
954
+ "consent": {
955
+ "type": "object",
956
+ "properties": {
957
+ "subject": {
958
+ "maxLength": 50,
959
+ "type": "string"
960
+ },
961
+ "version": {
962
+ "type": "integer"
963
+ }
964
+ },
965
+ "required": [
966
+ "subject",
967
+ "version"
968
+ ]
969
+ },
970
+ "translations": {
971
+ "type": "object",
972
+ "properties": {
973
+ "en": {
974
+ "type": "object",
975
+ "properties": {
976
+ "bodyTop": {
977
+ "type": "array",
978
+ "items": {
979
+ "type": "string"
980
+ }
981
+ },
982
+ "bodyList": {
983
+ "type": "array",
984
+ "items": {
985
+ "type": "string"
986
+ }
987
+ },
988
+ "bodyBottom": {
989
+ "type": "array",
990
+ "items": {
991
+ "type": "string"
992
+ }
993
+ },
994
+ "bodySmall": {
995
+ "type": "array",
996
+ "items": {
997
+ "type": "string"
998
+ }
999
+ },
1000
+ "bodyLinks": {
1001
+ "type": "object",
1002
+ "additionalProperties": {
1003
+ "type": "string"
1004
+ }
1005
+ },
1006
+ "bodyFooter": {
1007
+ "anyOf": [
1008
+ {
1009
+ "type": "string"
1010
+ },
1011
+ {
1012
+ "type": "null"
1013
+ }
1014
+ ]
1015
+ },
1016
+ "title": {
1017
+ "type": "string"
1018
+ }
1019
+ },
1020
+ "required": [
1021
+ "bodyTop",
1022
+ "bodyList",
1023
+ "bodyBottom",
1024
+ "bodySmall",
1025
+ "bodyLinks",
1026
+ "bodyFooter",
1027
+ "title"
1028
+ ]
1029
+ },
1030
+ "ga": {
1031
+ "type": "object",
1032
+ "properties": {
1033
+ "bodyTop": {
1034
+ "type": "array",
1035
+ "items": {
1036
+ "type": "string"
1037
+ }
1038
+ },
1039
+ "bodyList": {
1040
+ "type": "array",
1041
+ "items": {
1042
+ "type": "string"
1043
+ }
1044
+ },
1045
+ "bodyBottom": {
1046
+ "type": "array",
1047
+ "items": {
1048
+ "type": "string"
1049
+ }
1050
+ },
1051
+ "bodySmall": {
1052
+ "type": "array",
1053
+ "items": {
1054
+ "type": "string"
1055
+ }
1056
+ },
1057
+ "bodyLinks": {
1058
+ "type": "object",
1059
+ "additionalProperties": {
1060
+ "type": "string"
1061
+ }
1062
+ },
1063
+ "bodyFooter": {
1064
+ "anyOf": [
1065
+ {
1066
+ "type": "string"
1067
+ },
1068
+ {
1069
+ "type": "null"
1070
+ }
1071
+ ]
1072
+ },
1073
+ "title": {
1074
+ "type": "string"
1075
+ }
1076
+ },
1077
+ "required": [
1078
+ "bodyTop",
1079
+ "bodyList",
1080
+ "bodyBottom",
1081
+ "bodySmall",
1082
+ "bodyLinks",
1083
+ "bodyFooter",
1084
+ "title"
1085
+ ]
1086
+ }
1087
+ },
1088
+ "required": [
1089
+ "en",
1090
+ "ga"
1091
+ ]
1092
+ }
1093
+ },
1094
+ "required": [
1095
+ "consent",
1096
+ "translations"
1097
+ ]
1098
+ }
1099
+ }
1100
+ },
1101
+ "required": true
1102
+ },
1103
+ "responses": {
1104
+ "200": {
1105
+ "description": "Default Response",
1106
+ "content": {
1107
+ "application/json": {
1108
+ "schema": {
1109
+ "type": "object",
1110
+ "properties": {
1111
+ "data": {
1112
+ "type": "object",
1113
+ "properties": {
1114
+ "id": {
1115
+ "format": "uuid",
1116
+ "type": "string"
1117
+ }
1118
+ },
1119
+ "required": [
1120
+ "id"
1121
+ ]
1122
+ },
1123
+ "metadata": {
1124
+ "type": "object",
1125
+ "properties": {
1126
+ "links": {
1127
+ "description": "Object containing the links to the related endpoints",
1128
+ "type": "object",
1129
+ "properties": {
1130
+ "self": {
1131
+ "type": "object",
1132
+ "properties": {
1133
+ "href": {
1134
+ "description": "URL pointing to the request itself",
1135
+ "type": "string"
1136
+ }
1137
+ }
1138
+ },
1139
+ "next": {
1140
+ "type": "object",
1141
+ "properties": {
1142
+ "href": {
1143
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1144
+ "type": "string"
1145
+ }
1146
+ }
1147
+ },
1148
+ "prev": {
1149
+ "type": "object",
1150
+ "properties": {
1151
+ "href": {
1152
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1153
+ "type": "string"
1154
+ }
1155
+ }
1156
+ },
1157
+ "first": {
1158
+ "type": "object",
1159
+ "properties": {
1160
+ "href": {
1161
+ "description": "URL pointing to the first page of results in a paginated response",
1162
+ "type": "string"
1163
+ }
1164
+ }
1165
+ },
1166
+ "last": {
1167
+ "type": "object",
1168
+ "properties": {
1169
+ "href": {
1170
+ "description": "URL pointing to the first page of results in a paginated response",
1171
+ "type": "string"
1172
+ }
1173
+ }
1174
+ },
1175
+ "pages": {
1176
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1177
+ "type": "object",
1178
+ "additionalProperties": {
1179
+ "type": "object",
1180
+ "properties": {
1181
+ "href": {
1182
+ "type": "string"
1183
+ }
1184
+ }
1185
+ }
1186
+ }
1187
+ },
1188
+ "required": [
1189
+ "self",
1190
+ "first",
1191
+ "last",
1192
+ "pages"
1193
+ ]
1194
+ },
1195
+ "totalCount": {
1196
+ "description": "Number representing the total number of available items",
1197
+ "type": "number"
1198
+ }
1199
+ }
1200
+ }
1201
+ },
1202
+ "required": [
1203
+ "data"
1204
+ ]
1205
+ }
1206
+ }
1207
+ }
1208
+ },
1209
+ "4XX": {
1210
+ "description": "Default Response",
1211
+ "content": {
1212
+ "application/json": {
1213
+ "schema": {
1214
+ "type": "object",
1215
+ "properties": {
1216
+ "code": {
1217
+ "description": "Code used to categorize the error",
1218
+ "type": "string"
1219
+ },
1220
+ "detail": {
1221
+ "description": "Description of the error",
1222
+ "type": "string"
1223
+ },
1224
+ "requestId": {
1225
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1226
+ "type": "string"
1227
+ },
1228
+ "name": {
1229
+ "description": "Name of the error type",
1230
+ "type": "string"
1231
+ },
1232
+ "validation": {
1233
+ "description": "List of the validation errors",
1234
+ "type": "array",
1235
+ "items": {
1236
+ "type": "object",
1237
+ "properties": {
1238
+ "fieldName": {
1239
+ "type": "string"
1240
+ },
1241
+ "message": {
1242
+ "type": "string"
1243
+ }
1244
+ },
1245
+ "required": [
1246
+ "fieldName",
1247
+ "message"
1248
+ ]
1249
+ }
1250
+ },
1251
+ "validationContext": {
1252
+ "type": "string"
1253
+ },
1254
+ "statusCode": {
1255
+ "type": "number"
1256
+ }
1257
+ },
1258
+ "required": [
1259
+ "code",
1260
+ "detail",
1261
+ "requestId",
1262
+ "name",
1263
+ "statusCode"
1264
+ ]
1265
+ }
1266
+ }
1267
+ }
1268
+ },
1269
+ "5XX": {
1270
+ "description": "Default Response",
1271
+ "content": {
1272
+ "application/json": {
1273
+ "schema": {
1274
+ "type": "object",
1275
+ "properties": {
1276
+ "code": {
1277
+ "description": "Code used to categorize the error",
1278
+ "type": "string"
1279
+ },
1280
+ "detail": {
1281
+ "description": "Description of the error",
1282
+ "type": "string"
1283
+ },
1284
+ "requestId": {
1285
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1286
+ "type": "string"
1287
+ },
1288
+ "name": {
1289
+ "description": "Name of the error type",
1290
+ "type": "string"
1291
+ },
1292
+ "validation": {
1293
+ "description": "List of the validation errors",
1294
+ "type": "array",
1295
+ "items": {
1296
+ "type": "object",
1297
+ "properties": {
1298
+ "fieldName": {
1299
+ "type": "string"
1300
+ },
1301
+ "message": {
1302
+ "type": "string"
1303
+ }
1304
+ },
1305
+ "required": [
1306
+ "fieldName",
1307
+ "message"
1308
+ ]
1309
+ }
1310
+ },
1311
+ "validationContext": {
1312
+ "type": "string"
1313
+ },
1314
+ "statusCode": {
1315
+ "type": "number"
1316
+ }
1317
+ },
1318
+ "required": [
1319
+ "code",
1320
+ "detail",
1321
+ "requestId",
1322
+ "name",
1323
+ "statusCode"
1324
+ ]
1325
+ }
1326
+ }
1327
+ }
1328
+ }
1329
+ }
1330
+ }
1331
+ },
19
1332
  "/api/v1/citizens/consents/": {
20
1333
  "get": {
21
1334
  "operationId": "citizenListConsents",
@@ -117,6 +1430,10 @@
117
1430
  },
118
1431
  "createdAt": {
119
1432
  "type": "string"
1433
+ },
1434
+ "consentStatementId": {
1435
+ "format": "uuid",
1436
+ "type": "string"
120
1437
  }
121
1438
  },
122
1439
  "required": [
@@ -124,7 +1441,8 @@
124
1441
  "profileId",
125
1442
  "status",
126
1443
  "subject",
127
- "createdAt"
1444
+ "createdAt",
1445
+ "consentStatementId"
128
1446
  ]
129
1447
  }
130
1448
  },
@@ -387,11 +1705,16 @@
387
1705
  ]
388
1706
  }
389
1707
  ]
1708
+ },
1709
+ "consentStatementId": {
1710
+ "format": "uuid",
1711
+ "type": "string"
390
1712
  }
391
1713
  },
392
1714
  "required": [
393
1715
  "subject",
394
- "status"
1716
+ "status",
1717
+ "consentStatementId"
395
1718
  ]
396
1719
  }
397
1720
  }
@@ -625,6 +1948,10 @@
625
1948
  },
626
1949
  "createdAt": {
627
1950
  "type": "string"
1951
+ },
1952
+ "consentStatementId": {
1953
+ "format": "uuid",
1954
+ "type": "string"
628
1955
  }
629
1956
  },
630
1957
  "required": [
@@ -632,7 +1959,8 @@
632
1959
  "profileId",
633
1960
  "status",
634
1961
  "subject",
635
- "createdAt"
1962
+ "createdAt",
1963
+ "consentStatementId"
636
1964
  ]
637
1965
  },
638
1966
  "metadata": {
@@ -952,6 +2280,10 @@
952
2280
  },
953
2281
  "createdAt": {
954
2282
  "type": "string"
2283
+ },
2284
+ "consentStatementId": {
2285
+ "format": "uuid",
2286
+ "type": "string"
955
2287
  }
956
2288
  },
957
2289
  "required": [
@@ -959,7 +2291,8 @@
959
2291
  "profileId",
960
2292
  "status",
961
2293
  "subject",
962
- "createdAt"
2294
+ "createdAt",
2295
+ "consentStatementId"
963
2296
  ]
964
2297
  }
965
2298
  },
@@ -1439,10 +2772,14 @@
1439
2772
  "properties": {
1440
2773
  "name": {
1441
2774
  "type": "string"
2775
+ },
2776
+ "shortName": {
2777
+ "type": "string"
1442
2778
  }
1443
2779
  },
1444
2780
  "required": [
1445
- "name"
2781
+ "name",
2782
+ "shortName"
1446
2783
  ]
1447
2784
  },
1448
2785
  "ga": {
@@ -1450,10 +2787,14 @@
1450
2787
  "properties": {
1451
2788
  "name": {
1452
2789
  "type": "string"
2790
+ },
2791
+ "shortName": {
2792
+ "type": "string"
1453
2793
  }
1454
2794
  },
1455
2795
  "required": [
1456
- "name"
2796
+ "name",
2797
+ "shortName"
1457
2798
  ]
1458
2799
  }
1459
2800
  },
@@ -1810,37 +3151,50 @@
1810
3151
  "type": "object",
1811
3152
  "properties": {
1812
3153
  "messaging": {
1813
- "anyOf": [
1814
- {
1815
- "type": "string",
1816
- "enum": [
1817
- "pending"
1818
- ]
1819
- },
1820
- {
1821
- "type": "string",
1822
- "enum": [
1823
- "undefined"
3154
+ "type": "object",
3155
+ "properties": {
3156
+ "status": {
3157
+ "anyOf": [
3158
+ {
3159
+ "type": "string",
3160
+ "enum": [
3161
+ "pending"
3162
+ ]
3163
+ },
3164
+ {
3165
+ "type": "string",
3166
+ "enum": [
3167
+ "undefined"
3168
+ ]
3169
+ },
3170
+ {
3171
+ "type": "string",
3172
+ "enum": [
3173
+ "pre-approved"
3174
+ ]
3175
+ },
3176
+ {
3177
+ "type": "string",
3178
+ "enum": [
3179
+ "opted-out"
3180
+ ]
3181
+ },
3182
+ {
3183
+ "type": "string",
3184
+ "enum": [
3185
+ "opted-in"
3186
+ ]
3187
+ }
1824
3188
  ]
1825
3189
  },
1826
- {
1827
- "type": "string",
1828
- "enum": [
1829
- "pre-approved"
1830
- ]
1831
- },
1832
- {
1833
- "type": "string",
1834
- "enum": [
1835
- "opted-out"
1836
- ]
1837
- },
1838
- {
1839
- "type": "string",
1840
- "enum": [
1841
- "opted-in"
1842
- ]
3190
+ "consent_statement_id": {
3191
+ "format": "uuid",
3192
+ "type": "string"
1843
3193
  }
3194
+ },
3195
+ "required": [
3196
+ "status",
3197
+ "consent_statement_id"
1844
3198
  ]
1845
3199
  }
1846
3200
  },
@@ -2231,37 +3585,50 @@
2231
3585
  "type": "object",
2232
3586
  "properties": {
2233
3587
  "messaging": {
2234
- "anyOf": [
2235
- {
2236
- "type": "string",
2237
- "enum": [
2238
- "pending"
2239
- ]
2240
- },
2241
- {
2242
- "type": "string",
2243
- "enum": [
2244
- "undefined"
2245
- ]
2246
- },
2247
- {
2248
- "type": "string",
2249
- "enum": [
2250
- "pre-approved"
2251
- ]
2252
- },
2253
- {
2254
- "type": "string",
2255
- "enum": [
2256
- "opted-out"
3588
+ "type": "object",
3589
+ "properties": {
3590
+ "status": {
3591
+ "anyOf": [
3592
+ {
3593
+ "type": "string",
3594
+ "enum": [
3595
+ "pending"
3596
+ ]
3597
+ },
3598
+ {
3599
+ "type": "string",
3600
+ "enum": [
3601
+ "undefined"
3602
+ ]
3603
+ },
3604
+ {
3605
+ "type": "string",
3606
+ "enum": [
3607
+ "pre-approved"
3608
+ ]
3609
+ },
3610
+ {
3611
+ "type": "string",
3612
+ "enum": [
3613
+ "opted-out"
3614
+ ]
3615
+ },
3616
+ {
3617
+ "type": "string",
3618
+ "enum": [
3619
+ "opted-in"
3620
+ ]
3621
+ }
2257
3622
  ]
2258
3623
  },
2259
- {
2260
- "type": "string",
2261
- "enum": [
2262
- "opted-in"
2263
- ]
3624
+ "consent_statement_id": {
3625
+ "format": "uuid",
3626
+ "type": "string"
2264
3627
  }
3628
+ },
3629
+ "required": [
3630
+ "status",
3631
+ "consent_statement_id"
2265
3632
  ]
2266
3633
  }
2267
3634
  },
@@ -3091,37 +4458,50 @@
3091
4458
  "type": "object",
3092
4459
  "properties": {
3093
4460
  "messaging": {
3094
- "anyOf": [
3095
- {
3096
- "type": "string",
3097
- "enum": [
3098
- "pending"
3099
- ]
3100
- },
3101
- {
3102
- "type": "string",
3103
- "enum": [
3104
- "undefined"
3105
- ]
3106
- },
3107
- {
3108
- "type": "string",
3109
- "enum": [
3110
- "pre-approved"
3111
- ]
3112
- },
3113
- {
3114
- "type": "string",
3115
- "enum": [
3116
- "opted-out"
4461
+ "type": "object",
4462
+ "properties": {
4463
+ "status": {
4464
+ "anyOf": [
4465
+ {
4466
+ "type": "string",
4467
+ "enum": [
4468
+ "pending"
4469
+ ]
4470
+ },
4471
+ {
4472
+ "type": "string",
4473
+ "enum": [
4474
+ "undefined"
4475
+ ]
4476
+ },
4477
+ {
4478
+ "type": "string",
4479
+ "enum": [
4480
+ "pre-approved"
4481
+ ]
4482
+ },
4483
+ {
4484
+ "type": "string",
4485
+ "enum": [
4486
+ "opted-out"
4487
+ ]
4488
+ },
4489
+ {
4490
+ "type": "string",
4491
+ "enum": [
4492
+ "opted-in"
4493
+ ]
4494
+ }
3117
4495
  ]
3118
4496
  },
3119
- {
3120
- "type": "string",
3121
- "enum": [
3122
- "opted-in"
3123
- ]
4497
+ "consent_statement_id": {
4498
+ "format": "uuid",
4499
+ "type": "string"
3124
4500
  }
4501
+ },
4502
+ "required": [
4503
+ "status",
4504
+ "consent_statement_id"
3125
4505
  ]
3126
4506
  }
3127
4507
  },
@@ -3503,37 +4883,50 @@
3503
4883
  "type": "object",
3504
4884
  "properties": {
3505
4885
  "messaging": {
3506
- "anyOf": [
3507
- {
3508
- "type": "string",
3509
- "enum": [
3510
- "pending"
3511
- ]
3512
- },
3513
- {
3514
- "type": "string",
3515
- "enum": [
3516
- "undefined"
3517
- ]
3518
- },
3519
- {
3520
- "type": "string",
3521
- "enum": [
3522
- "pre-approved"
3523
- ]
3524
- },
3525
- {
3526
- "type": "string",
3527
- "enum": [
3528
- "opted-out"
4886
+ "type": "object",
4887
+ "properties": {
4888
+ "status": {
4889
+ "anyOf": [
4890
+ {
4891
+ "type": "string",
4892
+ "enum": [
4893
+ "pending"
4894
+ ]
4895
+ },
4896
+ {
4897
+ "type": "string",
4898
+ "enum": [
4899
+ "undefined"
4900
+ ]
4901
+ },
4902
+ {
4903
+ "type": "string",
4904
+ "enum": [
4905
+ "pre-approved"
4906
+ ]
4907
+ },
4908
+ {
4909
+ "type": "string",
4910
+ "enum": [
4911
+ "opted-out"
4912
+ ]
4913
+ },
4914
+ {
4915
+ "type": "string",
4916
+ "enum": [
4917
+ "opted-in"
4918
+ ]
4919
+ }
3529
4920
  ]
3530
4921
  },
3531
- {
3532
- "type": "string",
3533
- "enum": [
3534
- "opted-in"
3535
- ]
4922
+ "consent_statement_id": {
4923
+ "format": "uuid",
4924
+ "type": "string"
3536
4925
  }
4926
+ },
4927
+ "required": [
4928
+ "status",
4929
+ "consent_statement_id"
3537
4930
  ]
3538
4931
  }
3539
4932
  },
@@ -4593,37 +5986,50 @@
4593
5986
  "type": "object",
4594
5987
  "properties": {
4595
5988
  "messaging": {
4596
- "anyOf": [
4597
- {
4598
- "type": "string",
4599
- "enum": [
4600
- "pending"
4601
- ]
4602
- },
4603
- {
4604
- "type": "string",
4605
- "enum": [
4606
- "undefined"
4607
- ]
4608
- },
4609
- {
4610
- "type": "string",
4611
- "enum": [
4612
- "pre-approved"
4613
- ]
4614
- },
4615
- {
4616
- "type": "string",
4617
- "enum": [
4618
- "opted-out"
5989
+ "type": "object",
5990
+ "properties": {
5991
+ "status": {
5992
+ "anyOf": [
5993
+ {
5994
+ "type": "string",
5995
+ "enum": [
5996
+ "pending"
5997
+ ]
5998
+ },
5999
+ {
6000
+ "type": "string",
6001
+ "enum": [
6002
+ "undefined"
6003
+ ]
6004
+ },
6005
+ {
6006
+ "type": "string",
6007
+ "enum": [
6008
+ "pre-approved"
6009
+ ]
6010
+ },
6011
+ {
6012
+ "type": "string",
6013
+ "enum": [
6014
+ "opted-out"
6015
+ ]
6016
+ },
6017
+ {
6018
+ "type": "string",
6019
+ "enum": [
6020
+ "opted-in"
6021
+ ]
6022
+ }
4619
6023
  ]
4620
6024
  },
4621
- {
4622
- "type": "string",
4623
- "enum": [
4624
- "opted-in"
4625
- ]
6025
+ "consent_statement_id": {
6026
+ "format": "uuid",
6027
+ "type": "string"
4626
6028
  }
6029
+ },
6030
+ "required": [
6031
+ "status",
6032
+ "consent_statement_id"
4627
6033
  ]
4628
6034
  }
4629
6035
  },
@@ -5057,37 +6463,50 @@
5057
6463
  "type": "object",
5058
6464
  "properties": {
5059
6465
  "messaging": {
5060
- "anyOf": [
5061
- {
5062
- "type": "string",
5063
- "enum": [
5064
- "pending"
5065
- ]
5066
- },
5067
- {
5068
- "type": "string",
5069
- "enum": [
5070
- "undefined"
5071
- ]
5072
- },
5073
- {
5074
- "type": "string",
5075
- "enum": [
5076
- "pre-approved"
5077
- ]
5078
- },
5079
- {
5080
- "type": "string",
5081
- "enum": [
5082
- "opted-out"
6466
+ "type": "object",
6467
+ "properties": {
6468
+ "status": {
6469
+ "anyOf": [
6470
+ {
6471
+ "type": "string",
6472
+ "enum": [
6473
+ "pending"
6474
+ ]
6475
+ },
6476
+ {
6477
+ "type": "string",
6478
+ "enum": [
6479
+ "undefined"
6480
+ ]
6481
+ },
6482
+ {
6483
+ "type": "string",
6484
+ "enum": [
6485
+ "pre-approved"
6486
+ ]
6487
+ },
6488
+ {
6489
+ "type": "string",
6490
+ "enum": [
6491
+ "opted-out"
6492
+ ]
6493
+ },
6494
+ {
6495
+ "type": "string",
6496
+ "enum": [
6497
+ "opted-in"
6498
+ ]
6499
+ }
5083
6500
  ]
5084
6501
  },
5085
- {
5086
- "type": "string",
5087
- "enum": [
5088
- "opted-in"
5089
- ]
6502
+ "consent_statement_id": {
6503
+ "format": "uuid",
6504
+ "type": "string"
5090
6505
  }
6506
+ },
6507
+ "required": [
6508
+ "status",
6509
+ "consent_statement_id"
5091
6510
  ]
5092
6511
  }
5093
6512
  },
@@ -5495,37 +6914,50 @@
5495
6914
  "type": "object",
5496
6915
  "properties": {
5497
6916
  "messaging": {
5498
- "anyOf": [
5499
- {
5500
- "type": "string",
5501
- "enum": [
5502
- "pending"
5503
- ]
5504
- },
5505
- {
5506
- "type": "string",
5507
- "enum": [
5508
- "undefined"
5509
- ]
5510
- },
5511
- {
5512
- "type": "string",
5513
- "enum": [
5514
- "pre-approved"
5515
- ]
5516
- },
5517
- {
5518
- "type": "string",
5519
- "enum": [
5520
- "opted-out"
6917
+ "type": "object",
6918
+ "properties": {
6919
+ "status": {
6920
+ "anyOf": [
6921
+ {
6922
+ "type": "string",
6923
+ "enum": [
6924
+ "pending"
6925
+ ]
6926
+ },
6927
+ {
6928
+ "type": "string",
6929
+ "enum": [
6930
+ "undefined"
6931
+ ]
6932
+ },
6933
+ {
6934
+ "type": "string",
6935
+ "enum": [
6936
+ "pre-approved"
6937
+ ]
6938
+ },
6939
+ {
6940
+ "type": "string",
6941
+ "enum": [
6942
+ "opted-out"
6943
+ ]
6944
+ },
6945
+ {
6946
+ "type": "string",
6947
+ "enum": [
6948
+ "opted-in"
6949
+ ]
6950
+ }
5521
6951
  ]
5522
6952
  },
5523
- {
5524
- "type": "string",
5525
- "enum": [
5526
- "opted-in"
5527
- ]
6953
+ "consent_statement_id": {
6954
+ "format": "uuid",
6955
+ "type": "string"
5528
6956
  }
6957
+ },
6958
+ "required": [
6959
+ "status",
6960
+ "consent_statement_id"
5529
6961
  ]
5530
6962
  }
5531
6963
  },