-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsemantic-binding-openapi.yml
More file actions
1237 lines (1200 loc) · 49.1 KB
/
Copy pathsemantic-binding-openapi.yml
File metadata and controls
1237 lines (1200 loc) · 49.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.4
info:
title: Semantic Binding API
version: 0.1.0
# Enterprise license coverage is declared per operation with `x-license-protection`, so the
# OpenAPI contract can drift-check against static ServiceCommandContract license descriptors.
description: |
Connect existing records to the concepts defined in the semantic model (the catalogs and
profiles). The records are the parties in the directory (people, organizations, and systems),
the relationships between them, the services that act on them, and the external data sources
they read from. A binding annotates a record in place; it does not copy or restructure the
record, so a catalog's governance and interoperability rules apply to data wherever it is held.
Five kinds of binding are managed through this API:
- **Party-type bindings** declare that a kind of record (a party type, optionally a subtype)
stands for a particular catalog or profile concept, so every record of that type inherits
that meaning.
- **Party attribute values** attach a semantically-keyed value to one specific record,
addressed by its catalog or profile attribute path. The value keeps its meaning and may be a
scalar, an array, or a nested object.
- **Relationship bindings** map a relationship between two records (a subject and an object, of
a governed relation type) to a profile relation, which gives it its use-case meaning.
- **Service capabilities** record which concepts, profiles, sets, and channels a service can
work with.
- **Source bindings** connect a registered data source (a system or service that holds
attribute data) to the attributes of a version-pinned catalog, so the source's fields inherit
those attributes' governance rules. The values are either copied in or only referenced in
place (see `MaterializationPolicy`).
Every request runs within the caller's tenant, resolved from the OIDC bearer token. The optional
`X-Tenant-Id` header is informational only and is not used for access control. All changes
require the `semantic-attribute-binding` enterprise entitlement.
servers:
- url: http://localhost:8080/api/semantic/binding/v1
description: Local development.
security:
- bearer: []
tags:
- name: PartyTypeBindings
description: Map a kind of record (a party type, optionally a subtype) to a catalog or profile concept.
- name: PartyAttributeValues
description: Attach semantically-keyed attribute values to specific party records.
- name: RelationshipBindings
description: Map a relationship between two records to a profile relation.
- name: ServiceCapabilities
description: Declare which concepts, profiles, sets, and channels a service can work with.
- name: SourceBindings
description: Bind a registered data source to the attributes of a version-pinned catalog.
paths:
/partytypebindings:
post:
tags: [PartyTypeBindings]
summary: Create a semantic party-type binding
operationId: createSemanticPartyTypeBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.create-party-type-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSemanticPartyTypeBindingInput'
responses:
'201':
description: Party-type binding created.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyTypeBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
get:
tags: [PartyTypeBindings]
summary: List semantic party-type bindings
operationId: listSemanticPartyTypeBindings
x-license-protection:
entitlementKey: vdx.semantic.binding.list-party-type-bindings
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Returns a page of party-type bindings in the calling tenant, narrowed by the optional
filter. Pagination accepts both `limit`/`offset` and OpenAPI-style `page`/`size`; the
parser normalises and clamps `limit` to `[1, 100]` (default `20`). Default sort is
`createdAt DESC`.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
- name: partyType
in: query
description: Restrict to bindings whose party type equals this exact value.
schema:
type: string
- name: partySubtype
in: query
description: Restrict to bindings whose CTI subtype equals this exact value.
schema:
type: string
- $ref: './common-components.yml#/components/parameters/Limit'
- $ref: './common-components.yml#/components/parameters/Offset'
- $ref: './common-components.yml#/components/parameters/Page'
- $ref: './common-components.yml#/components/parameters/Size'
- $ref: './common-components.yml#/components/parameters/Sort'
- $ref: './common-components.yml#/components/parameters/SortDirection'
responses:
'200':
description: Page of party-type bindings.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyTypeBindingPageResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
/partytypebindings/{id}:
parameters:
- $ref: '#/components/parameters/BindingId'
get:
tags: [PartyTypeBindings]
summary: Get one semantic party-type binding
operationId: getSemanticPartyTypeBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.get-party-type-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Party-type binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyTypeBinding'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
put:
tags: [PartyTypeBindings]
summary: Update a semantic party-type binding
operationId: updateSemanticPartyTypeBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.update-party-type-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSemanticPartyTypeBindingInput'
responses:
'200':
description: Updated party-type binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyTypeBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
delete:
tags: [PartyTypeBindings]
summary: Soft-delete a semantic party-type binding
operationId: deleteSemanticPartyTypeBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.delete-party-type-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'204':
description: Party-type binding soft-deleted.
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
/partyattributevalues:
post:
tags: [PartyAttributeValues]
summary: Create a semantic party attribute value
operationId: createSemanticPartyAttributeValue
x-license-protection:
entitlementKey: vdx.semantic.binding.create-party-attribute-value
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSemanticPartyAttributeValueInput'
responses:
'201':
description: Party attribute value created.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyAttributeValue'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
get:
tags: [PartyAttributeValues]
summary: List semantic party attribute values
operationId: listSemanticPartyAttributeValues
x-license-protection:
entitlementKey: vdx.semantic.binding.list-party-attribute-values
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Returns a page of party attribute values in the calling tenant, optionally scoped to one
party. Pagination accepts both `limit`/`offset` and OpenAPI-style `page`/`size`; `limit`
is clamped to `[1, 100]` (default `20`). Default sort is `createdAt DESC`.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
- name: partyId
in: query
description: Restrict to values attached to this exact party record.
schema:
type: string
format: uuid
- $ref: './common-components.yml#/components/parameters/Limit'
- $ref: './common-components.yml#/components/parameters/Offset'
- $ref: './common-components.yml#/components/parameters/Page'
- $ref: './common-components.yml#/components/parameters/Size'
- $ref: './common-components.yml#/components/parameters/Sort'
- $ref: './common-components.yml#/components/parameters/SortDirection'
responses:
'200':
description: Page of party attribute values.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyAttributeValuePageResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
/partyattributevalues/{id}:
parameters:
- $ref: '#/components/parameters/BindingId'
get:
tags: [PartyAttributeValues]
summary: Get one semantic party attribute value
operationId: getSemanticPartyAttributeValue
x-license-protection:
entitlementKey: vdx.semantic.binding.get-party-attribute-value
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Party attribute value.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyAttributeValue'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
put:
tags: [PartyAttributeValues]
summary: Update a semantic party attribute value
operationId: updateSemanticPartyAttributeValue
x-license-protection:
entitlementKey: vdx.semantic.binding.update-party-attribute-value
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSemanticPartyAttributeValueInput'
responses:
'200':
description: Updated party attribute value.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticPartyAttributeValue'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
delete:
tags: [PartyAttributeValues]
summary: Soft-delete a semantic party attribute value
operationId: deleteSemanticPartyAttributeValue
x-license-protection:
entitlementKey: vdx.semantic.binding.delete-party-attribute-value
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'204':
description: Party attribute value soft-deleted.
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
/relationshipbindings:
post:
tags: [RelationshipBindings]
summary: Create a semantic relationship binding
operationId: createSemanticRelationshipBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.create-relationship-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Creates a relationship binding. The create command validates `relationType` against the
the relationship-type registry and, when the optional endpoint party types are supplied,
checks endpoint compatibility.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSemanticRelationshipBindingInput'
responses:
'201':
description: Relationship binding created.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticRelationshipBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
get:
tags: [RelationshipBindings]
summary: List semantic relationship bindings
operationId: listSemanticRelationshipBindings
x-license-protection:
entitlementKey: vdx.semantic.binding.list-relationship-bindings
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Returns a page of relationship bindings in the calling tenant, optionally scoped to a
subject party, object party, and/or governed relation type (e.g. to read all roles a
given subject party holds). Pagination accepts both `limit`/`offset` and OpenAPI-style
`page`/`size`; `limit` is clamped to `[1, 100]` (default `20`). Default sort is
`createdAt DESC`.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
- name: subjectPartyId
in: query
description: Restrict to bindings whose subject endpoint is this exact party.
schema:
type: string
format: uuid
- name: objectPartyId
in: query
description: Restrict to bindings whose object endpoint is this exact party.
schema:
type: string
format: uuid
- name: relationType
in: query
description: Restrict to bindings with this exact governed directed relation id.
schema:
type: string
- $ref: './common-components.yml#/components/parameters/Limit'
- $ref: './common-components.yml#/components/parameters/Offset'
- $ref: './common-components.yml#/components/parameters/Page'
- $ref: './common-components.yml#/components/parameters/Size'
- $ref: './common-components.yml#/components/parameters/Sort'
- $ref: './common-components.yml#/components/parameters/SortDirection'
responses:
'200':
description: Page of relationship bindings.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticRelationshipBindingPageResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
/relationshipbindings/{id}:
parameters:
- $ref: '#/components/parameters/BindingId'
get:
tags: [RelationshipBindings]
summary: Get one semantic relationship binding
operationId: getSemanticRelationshipBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.get-relationship-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Relationship binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticRelationshipBinding'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
put:
tags: [RelationshipBindings]
summary: Update a semantic relationship binding
operationId: updateSemanticRelationshipBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.update-relationship-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: Re-validates the governed relation type and endpoint compatibility before persisting.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSemanticRelationshipBindingInput'
responses:
'200':
description: Updated relationship binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticRelationshipBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
delete:
tags: [RelationshipBindings]
summary: Soft-delete a semantic relationship binding
operationId: deleteSemanticRelationshipBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.delete-relationship-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'204':
description: Relationship binding soft-deleted.
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
/servicecapabilities:
post:
tags: [ServiceCapabilities]
summary: Create a semantic service capability
operationId: createSemanticServiceCapability
x-license-protection:
entitlementKey: vdx.semantic.binding.create-service-capability
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSemanticServiceCapabilityInput'
responses:
'201':
description: Service capability created.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticServiceCapability'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
get:
tags: [ServiceCapabilities]
summary: List semantic service capabilities
operationId: listSemanticServiceCapabilities
x-license-protection:
entitlementKey: vdx.semantic.binding.list-service-capabilities
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Returns a page of service-capability declarations in the calling tenant, optionally
scoped to one service id. Pagination accepts both `limit`/`offset` and OpenAPI-style
`page`/`size`; `limit` is clamped to `[1, 100]` (default `20`). Default sort is
`createdAt DESC`.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
- name: serviceId
in: query
description: Restrict to capabilities declared for this exact service id.
schema:
type: string
- $ref: './common-components.yml#/components/parameters/Limit'
- $ref: './common-components.yml#/components/parameters/Offset'
- $ref: './common-components.yml#/components/parameters/Page'
- $ref: './common-components.yml#/components/parameters/Size'
- $ref: './common-components.yml#/components/parameters/Sort'
- $ref: './common-components.yml#/components/parameters/SortDirection'
responses:
'200':
description: Page of service capabilities.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticServiceCapabilityPageResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
/servicecapabilities/{id}:
parameters:
- $ref: '#/components/parameters/BindingId'
get:
tags: [ServiceCapabilities]
summary: Get one semantic service capability
operationId: getSemanticServiceCapability
x-license-protection:
entitlementKey: vdx.semantic.binding.get-service-capability
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Service capability.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticServiceCapability'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
put:
tags: [ServiceCapabilities]
summary: Update a semantic service capability
operationId: updateSemanticServiceCapability
x-license-protection:
entitlementKey: vdx.semantic.binding.update-service-capability
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSemanticServiceCapabilityInput'
responses:
'200':
description: Updated service capability.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticServiceCapability'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
delete:
tags: [ServiceCapabilities]
summary: Soft-delete a semantic service capability
operationId: deleteSemanticServiceCapability
x-license-protection:
entitlementKey: vdx.semantic.binding.delete-service-capability
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'204':
description: Service capability soft-deleted.
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
/sourcebindings:
post:
tags: [SourceBindings]
summary: Bind a registered attribute source to catalog attributes
operationId: createSemanticSourceBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.create-source-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Binds a registered attribute source (a software/server party carrying an `ATTRIBUTE_SOURCE`
capability) to the attributes of a version-pinned catalog. The source's native fields map onto
catalog attribute paths and inherit those attributes' governance overlays; whether the resolved
values are stored or only referenced is controlled by `materialization`. The id, tenant and
timestamps are assigned by the command (tenant from the session).
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSemanticSourceBindingInput'
responses:
'201':
description: Source binding created.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticSourceBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
get:
tags: [SourceBindings]
summary: List semantic source bindings
operationId: listSemanticSourceBindings
x-license-protection:
entitlementKey: vdx.semantic.binding.list-source-bindings
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
description: |
Returns a page of source bindings in the calling tenant, optionally scoped to a source party
and/or the bound catalog. Pagination accepts both `limit`/`offset` and OpenAPI-style
`page`/`size`; `limit` is clamped to `[1, 100]` (default `20`). Default sort is `createdAt DESC`.
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
- name: sourcePartyId
in: query
description: Restrict to bindings whose attribute source is this exact software/server party.
schema:
type: string
format: uuid
- name: catalogId
in: query
description: Restrict to bindings whose bound catalog has this exact id.
schema:
type: string
format: uuid
- $ref: './common-components.yml#/components/parameters/Limit'
- $ref: './common-components.yml#/components/parameters/Offset'
- $ref: './common-components.yml#/components/parameters/Page'
- $ref: './common-components.yml#/components/parameters/Size'
- $ref: './common-components.yml#/components/parameters/Sort'
- $ref: './common-components.yml#/components/parameters/SortDirection'
responses:
'200':
description: Page of source bindings.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticSourceBindingPageResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'500':
$ref: './common-components.yml#/components/responses/Error'
/sourcebindings/{id}:
parameters:
- $ref: '#/components/parameters/BindingId'
get:
tags: [SourceBindings]
summary: Get one semantic source binding
operationId: getSemanticSourceBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.get-source-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Source binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticSourceBinding'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
put:
tags: [SourceBindings]
summary: Update a semantic source binding
operationId: updateSemanticSourceBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.update-source-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSemanticSourceBindingInput'
responses:
'200':
description: Updated source binding.
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticSourceBinding'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
delete:
tags: [SourceBindings]
summary: Soft-delete a semantic source binding
operationId: deleteSemanticSourceBinding
x-license-protection:
entitlementKey: vdx.semantic.binding.delete-source-binding
deploymentShapePredicates: [packaging=container, environment=production]
protectionMode: licensed
parameters:
- $ref: './common-components.yml#/components/parameters/TenantId'
responses:
'204':
description: Source binding soft-deleted.
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
'500':
$ref: './common-components.yml#/components/responses/Error'
components:
# Shared parameters (TenantId), pagination params (Limit/Offset/Page/Size/Sort/SortDirection),
# error responses (NotFound/ValidationError/Unauthorized/Forbidden/Error), and the
# ApiError/ErrorResponse/PageMeta schemas are defined in the canonical shared
# ./common-components.yml (owned by IDK lib-core-api-public, copied in at build time).
# Only semantic-binding-specific components are defined locally below.
parameters:
BindingId:
$ref: './semantic-binding-components.yml#/components/parameters/BindingId'
schemas:
# ---- Shared reference value objects ----------------------------------
SemanticConceptRefKind:
$ref: './semantic-binding-components.yml#/components/schemas/SemanticConceptRefKind'
SemanticConceptRef:
$ref: './semantic-binding-components.yml#/components/schemas/SemanticConceptRef'
ProfileRelationRef:
$ref: './semantic-binding-components.yml#/components/schemas/ProfileRelationRef'
# ---- Party-type binding ----------------------------------------------
SemanticPartyTypeBinding:
$ref: './semantic-binding-components.yml#/components/schemas/SemanticPartyTypeBinding'
CreateSemanticPartyTypeBindingInput:
type: object
description: |
Input for creating a party-type binding. The id, tenant and timestamps are assigned by the
command (tenant from the session); only the authored fields are accepted.
required: [partyType, semanticConceptRef]
example:
partyType: "natural_person"
partySubtype: "employee"
semanticConceptRef:
kind: CATALOG_ATTRIBUTE
catalogId: "9f2c1b3e-7a44-4c1e-8b0a-2d6f5e9c1a77"
properties:
partyType:
type: string
partySubtype:
type: string
nullable: true
semanticConceptRef:
$ref: '#/components/schemas/SemanticConceptRef'
UpdateSemanticPartyTypeBindingInput:
type: object
description: |
Input for updating the mutable fields of a party-type binding. The path `{id}` identifies
the record and overrides any `id` in the body.
required: [partyType, semanticConceptRef]
properties:
partyType:
type: string
partySubtype:
type: string
nullable: true
semanticConceptRef:
$ref: '#/components/schemas/SemanticConceptRef'
SemanticPartyTypeBindingPageResponse:
type: object
description: Paged list of party-type bindings.
required: [data, pagination]
properties:
data:
type: array
items:
$ref: '#/components/schemas/SemanticPartyTypeBinding'
pagination:
$ref: './common-components.yml#/components/schemas/PageMeta'
# ---- Party attribute value -------------------------------------------
SemanticPartyAttributeValue:
$ref: './semantic-binding-components.yml#/components/schemas/SemanticPartyAttributeValue'
CreateSemanticPartyAttributeValueInput:
type: object
description: |
Input for creating a party attribute value. The `value` may be a scalar, array, or nested
object. The id, tenant and timestamps are assigned by the command (tenant from the session).
required: [partyId, conceptRef, attributePath, value]
example:
partyId: "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d"
conceptRef:
kind: CATALOG_ATTRIBUTE
catalogId: "9f2c1b3e-7a44-4c1e-8b0a-2d6f5e9c1a77"
attributePath: "address.postalCode"
attributePath: "address.postalCode"
value: "1011AB"
properties:
partyId:
type: string
format: uuid
conceptRef:
$ref: '#/components/schemas/SemanticConceptRef'
attributePath:
type: string
description: Dot-separated attribute path (e.g. `address.postal_code`).
value:
description: The attribute value as arbitrary JSON (scalar, array, or nested object).
UpdateSemanticPartyAttributeValueInput:
type: object
description: |
Input for updating the mutable fields of a party attribute value. The path `{id}` identifies
the record and overrides any `id` in the body.
required: [partyId, conceptRef, attributePath, value]
properties:
partyId:
type: string
format: uuid
conceptRef:
$ref: '#/components/schemas/SemanticConceptRef'
attributePath:
type: string
description: Dot-separated attribute path (e.g. `address.postal_code`).
value:
description: The attribute value as arbitrary JSON (scalar, array, or nested object).
SemanticPartyAttributeValuePageResponse:
type: object
description: Paged list of party attribute values.
required: [data, pagination]
properties:
data:
type: array
items:
$ref: '#/components/schemas/SemanticPartyAttributeValue'
pagination:
$ref: './common-components.yml#/components/schemas/PageMeta'
# ---- Relationship binding --------------------------------------------
SemanticRelationshipBinding:
$ref: './semantic-binding-components.yml#/components/schemas/SemanticRelationshipBinding'
CreateSemanticRelationshipBindingInput:
type: object
description: |
Input for creating a relationship binding. The create command validates `relationType`
against the relationship-type registry and, when the optional endpoint party types are
supplied, checks endpoint compatibility. The id, tenant and timestamps are assigned by the
command (tenant from the session).
required: [subjectPartyId, objectPartyId, relationType]
example:
subjectPartyId: "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d"
objectPartyId: "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f"
relationType: "employed-by"
subjectPartyType: "natural_person"
objectPartyType: "organization"
properties:
subjectPartyId:
type: string
format: uuid
objectPartyId:
type: string
format: uuid
relationType:
type: string
relationshipInstanceId:
type: string
format: uuid
nullable: true
profileRelationRef:
allOf:
- $ref: '#/components/schemas/ProfileRelationRef'
nullable: true
subjectPartyType:
type: string
nullable: true
description: Optional semantic party type of the subject endpoint, for the endpoint-compatibility check; null skips it.
objectPartyType:
type: string
nullable: true
description: Optional semantic party type of the object endpoint; null skips it.
UpdateSemanticRelationshipBindingInput:
type: object
description: |