@nmshd/runtime 2.0.0-alpha.25 → 2.0.0-alpha.28

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.
Files changed (52) hide show
  1. package/README.md +2 -2
  2. package/dist/buildInformation.js +5 -5
  3. package/dist/dataViews/DataViewExpander.d.ts +26 -19
  4. package/dist/dataViews/DataViewExpander.js +352 -56
  5. package/dist/dataViews/DataViewExpander.js.map +1 -1
  6. package/dist/dataViews/consumption/DecidableRequestItemDVOs.d.ts +30 -0
  7. package/dist/dataViews/consumption/DecidableRequestItemDVOs.js +3 -0
  8. package/dist/dataViews/consumption/DecidableRequestItemDVOs.js.map +1 -0
  9. package/dist/dataViews/consumption/LocalAttributeDVO.d.ts +41 -25
  10. package/dist/dataViews/consumption/LocalRequestDVO.d.ts +8 -2
  11. package/dist/dataViews/consumption/PeerRelationshipTemplateDVO.d.ts +18 -0
  12. package/dist/dataViews/consumption/PeerRelationshipTemplateDVO.js +3 -0
  13. package/dist/dataViews/consumption/PeerRelationshipTemplateDVO.js.map +1 -0
  14. package/dist/dataViews/consumption/index.d.ts +2 -0
  15. package/dist/dataViews/consumption/index.js +2 -0
  16. package/dist/dataViews/consumption/index.js.map +1 -1
  17. package/dist/dataViews/content/AttributeDVOs.d.ts +37 -0
  18. package/dist/dataViews/content/AttributeDVOs.js +3 -0
  19. package/dist/dataViews/content/AttributeDVOs.js.map +1 -0
  20. package/dist/dataViews/content/MailDVOs.d.ts +4 -5
  21. package/dist/dataViews/content/RequestDVO.d.ts +7 -0
  22. package/dist/dataViews/content/{RequestDVOs.js → RequestDVO.js} +1 -1
  23. package/dist/dataViews/content/RequestDVO.js.map +1 -0
  24. package/dist/dataViews/content/RequestItemDVOs.d.ts +36 -0
  25. package/dist/dataViews/content/RequestItemDVOs.js +3 -0
  26. package/dist/dataViews/content/RequestItemDVOs.js.map +1 -0
  27. package/dist/dataViews/content/index.d.ts +3 -1
  28. package/dist/dataViews/content/index.js +3 -1
  29. package/dist/dataViews/content/index.js.map +1 -1
  30. package/dist/dataViews/transport/MessageDVO.d.ts +4 -0
  31. package/dist/dataViews/transport/RelationshipDVO.d.ts +2 -2
  32. package/dist/dataViews/transport/RelationshipTemplateDVO.d.ts +8 -2
  33. package/dist/modules/RequestModule.js +3 -1
  34. package/dist/modules/RequestModule.js.map +1 -1
  35. package/dist/useCases/common/Schemas.js +2221 -476
  36. package/dist/useCases/common/Schemas.js.map +1 -1
  37. package/dist/useCases/consumption/attributes/CreateSharedAttributeCopy.js +1 -1
  38. package/dist/useCases/consumption/attributes/CreateSharedAttributeCopy.js.map +1 -1
  39. package/dist/useCases/consumption/attributes/ExecuteIdentityAttributeQuery.js +2 -4
  40. package/dist/useCases/consumption/attributes/ExecuteIdentityAttributeQuery.js.map +1 -1
  41. package/dist/useCases/consumption/attributes/ExecuteRelationshipAttributeQuery.js +2 -4
  42. package/dist/useCases/consumption/attributes/ExecuteRelationshipAttributeQuery.js.map +1 -1
  43. package/dist/useCases/consumption/attributes/GetAttributes.d.ts +1 -1
  44. package/dist/useCases/consumption/attributes/GetAttributes.js +2 -0
  45. package/dist/useCases/consumption/attributes/GetAttributes.js.map +1 -1
  46. package/lib-web/nmshd.runtime.js +2693 -596
  47. package/lib-web/nmshd.runtime.js.map +1 -1
  48. package/lib-web/nmshd.runtime.min.js +3 -3
  49. package/lib-web/nmshd.runtime.min.js.map +1 -1
  50. package/package.json +5 -5
  51. package/dist/dataViews/content/RequestDVOs.d.ts +0 -62
  52. package/dist/dataViews/content/RequestDVOs.js.map +0 -1
package/dist/useCases/common/Schemas.js CHANGED
@@ -459,6 +459,12 @@ exports.ExecuteRelationshipAttributeQueryRequest = {
459
459
  "number",
460
460
  "boolean"
461
461
  ]
462
+ },
463
+ "propertyHints": {
464
+ "type": "object",
465
+ "additionalProperties": {
466
+ "$ref": "#/definitions/IValueHints"
467
+ }
462
468
  }
463
469
  },
464
470
  "additionalProperties": false
@@ -595,6 +601,12 @@ exports.ExecuteRelationshipAttributeQueryRequest = {
595
601
  "number",
596
602
  "boolean"
597
603
  ]
604
+ },
605
+ "propertyHints": {
606
+ "type": "object",
607
+ "additionalProperties": {
608
+ "$ref": "#/definitions/ValueHintsJSON"
609
+ }
598
610
  }
599
611
  },
600
612
  "additionalProperties": false,
@@ -711,19 +723,26 @@ exports.GetAttributesRequest = {
711
723
  "type": "string"
712
724
  },
713
725
  "shareInfo": {
714
- "type": "object",
715
- "properties": {
716
- "requestReference": {
717
- "type": "string"
718
- },
719
- "peer": {
720
- "type": "string"
726
+ "anyOf": [
727
+ {
728
+ "type": "object",
729
+ "properties": {
730
+ "requestReference": {
731
+ "type": "string"
732
+ },
733
+ "peer": {
734
+ "type": "string"
735
+ },
736
+ "sourceAttribute": {
737
+ "type": "string"
738
+ }
739
+ },
740
+ "additionalProperties": false
721
741
  },
722
- "sourceAttribute": {
742
+ {
723
743
  "type": "string"
724
744
  }
725
- },
726
- "additionalProperties": false
745
+ ]
727
746
  }
728
747
  },
729
748
  "additionalProperties": {}
@@ -1331,11 +1350,11 @@ exports.CreateOutgoingRequestRequest = {
1331
1350
  "$ref": "#/definitions/RequestItemGroupJSON"
1332
1351
  },
1333
1352
  {
1334
- "$ref": "#/definitions/RequestItemJSON"
1353
+ "$ref": "#/definitions/RequestItemJSONDerivations"
1335
1354
  }
1336
1355
  ]
1337
1356
  },
1338
- "description": "The items of the Request. Can be either a single {@link RequestItemJSON RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSON RequestItems } ."
1357
+ "description": "The items of the Request. Can be either a single {@link RequestItemJSONDerivations RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSONDerivations RequestItems } ."
1339
1358
  },
1340
1359
  {
1341
1360
  "type": "array",
@@ -1345,16 +1364,16 @@ exports.CreateOutgoingRequestRequest = {
1345
1364
  "$ref": "#/definitions/IRequestItemGroup"
1346
1365
  },
1347
1366
  {
1348
- "$ref": "#/definitions/IRequestItem"
1367
+ "$ref": "#/definitions/IRequestItemDerivations"
1349
1368
  }
1350
1369
  ]
1351
1370
  },
1352
- "description": "The items of the Request. Can be either a single {@link RequestItem RequestItem } or a {@link RequestItemGroup RequestItemGroup } , which itself can contain further {@link RequestItem RequestItems } ."
1371
+ "description": "The items of the Request. Can be either a single {@link IRequestItemDerivations RequestItem } or a {@link IRequestItemGroup RequestItemGroup } , which itself can contain further {@link IRequestItemDerivations RequestItems } ."
1353
1372
  }
1354
1373
  ],
1355
- "description": "The items of the Request. Can be either a single {@link RequestItemJSON RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSON RequestItems } ."
1374
+ "description": "The items of the Request. Can be either a single {@link RequestItemJSONDerivations RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSONDerivations RequestItems } ."
1356
1375
  },
1357
- "responseMetadata": {
1376
+ "metadata": {
1358
1377
  "anyOf": [
1359
1378
  {
1360
1379
  "type": "object",
@@ -1423,14 +1442,14 @@ exports.CreateOutgoingRequestRequest = {
1423
1442
  "type": "boolean",
1424
1443
  "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
1425
1444
  },
1426
- "responseMetadata": {
1445
+ "metadata": {
1427
1446
  "type": "object",
1428
1447
  "description": "This property can be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1429
1448
  },
1430
1449
  "items": {
1431
1450
  "type": "array",
1432
1451
  "items": {
1433
- "$ref": "#/definitions/RequestItemJSON"
1452
+ "$ref": "#/definitions/RequestItemJSONDerivations"
1434
1453
  },
1435
1454
  "description": "The items of this group."
1436
1455
  }
@@ -1441,7 +1460,26 @@ exports.CreateOutgoingRequestRequest = {
1441
1460
  "mustBeAccepted"
1442
1461
  ],
1443
1462
  "additionalProperties": false,
1444
- "description": "A RequestItemGroup can be used to group one or more {@link RequestItemJSON RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
1463
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
1464
+ },
1465
+ "RequestItemJSONDerivations": {
1466
+ "anyOf": [
1467
+ {
1468
+ "$ref": "#/definitions/RequestItemJSON"
1469
+ },
1470
+ {
1471
+ "$ref": "#/definitions/CreateAttributeRequestItemJSON"
1472
+ },
1473
+ {
1474
+ "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
1475
+ },
1476
+ {
1477
+ "$ref": "#/definitions/ReadAttributeRequestItemJSON"
1478
+ },
1479
+ {
1480
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
1481
+ }
1482
+ ]
1445
1483
  },
1446
1484
  "RequestItemJSON": {
1447
1485
  "type": "object",
@@ -1463,7 +1501,7 @@ exports.CreateOutgoingRequestRequest = {
1463
1501
  "type": "string",
1464
1502
  "description": "The human-readable description of this item."
1465
1503
  },
1466
- "responseMetadata": {
1504
+ "metadata": {
1467
1505
  "type": "object",
1468
1506
  "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1469
1507
  },
@@ -1478,43 +1516,18 @@ exports.CreateOutgoingRequestRequest = {
1478
1516
  ],
1479
1517
  "additionalProperties": false
1480
1518
  },
1481
- "IRequestItemGroup": {
1519
+ "CreateAttributeRequestItemJSON": {
1482
1520
  "type": "object",
1483
1521
  "properties": {
1484
- "title": {
1485
- "type": "string",
1486
- "description": "The human-readable title of this group."
1487
- },
1488
- "description": {
1489
- "type": "string",
1490
- "description": "The human-readable description of this group."
1522
+ "@type": {
1523
+ "type": "string"
1491
1524
  },
1492
- "mustBeAccepted": {
1493
- "type": "boolean",
1494
- "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
1525
+ "@context": {
1526
+ "type": "string"
1495
1527
  },
1496
- "responseMetadata": {
1497
- "type": "object",
1498
- "description": "This property can be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1528
+ "@version": {
1529
+ "type": "string"
1499
1530
  },
1500
- "items": {
1501
- "type": "array",
1502
- "items": {
1503
- "$ref": "#/definitions/IRequestItem"
1504
- },
1505
- "description": "The items of this group."
1506
- }
1507
- },
1508
- "required": [
1509
- "mustBeAccepted",
1510
- "items"
1511
- ],
1512
- "additionalProperties": false,
1513
- "description": "A RequestItemGroup can be used to group one or more {@link RequestItem RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
1514
- },
1515
- "IRequestItem": {
1516
- "type": "object",
1517
- "properties": {
1518
1531
  "title": {
1519
1532
  "type": "string",
1520
1533
  "description": "The human-readable title of this item."
@@ -1523,176 +1536,301 @@ exports.CreateOutgoingRequestRequest = {
1523
1536
  "type": "string",
1524
1537
  "description": "The human-readable description of this item."
1525
1538
  },
1526
- "responseMetadata": {
1539
+ "metadata": {
1527
1540
  "type": "object",
1528
1541
  "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1529
1542
  },
1530
1543
  "mustBeAccepted": {
1531
1544
  "type": "boolean",
1532
- "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
1545
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
1546
+ },
1547
+ "attribute": {
1548
+ "anyOf": [
1549
+ {
1550
+ "$ref": "#/definitions/IdentityAttributeJSON"
1551
+ },
1552
+ {
1553
+ "$ref": "#/definitions/RelationshipAttributeJSON"
1554
+ }
1555
+ ]
1556
+ },
1557
+ "sourceAttributeId": {
1558
+ "type": "string"
1533
1559
  }
1534
1560
  },
1535
1561
  "required": [
1562
+ "@type",
1563
+ "attribute",
1536
1564
  "mustBeAccepted"
1537
1565
  ],
1538
1566
  "additionalProperties": false
1539
- }
1540
- }
1541
- };
1542
- exports.RejectIncomingRequestRequest = {
1543
- "$schema": "http://json-schema.org/draft-07/schema#",
1544
- "$ref": "#/definitions/RejectIncomingRequestRequest",
1545
- "definitions": {
1546
- "RejectIncomingRequestRequest": {
1567
+ },
1568
+ "IdentityAttributeJSON": {
1547
1569
  "type": "object",
1548
- "additionalProperties": false,
1549
1570
  "properties": {
1550
- "requestId": {
1571
+ "@type": {
1551
1572
  "type": "string"
1552
1573
  },
1553
- "items": {
1574
+ "@context": {
1575
+ "type": "string"
1576
+ },
1577
+ "@version": {
1578
+ "type": "string"
1579
+ },
1580
+ "owner": {
1581
+ "type": "string"
1582
+ },
1583
+ "validFrom": {
1584
+ "type": "string"
1585
+ },
1586
+ "validTo": {
1587
+ "type": "string"
1588
+ },
1589
+ "value": {
1590
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
1591
+ },
1592
+ "tags": {
1554
1593
  "type": "array",
1555
1594
  "items": {
1556
- "anyOf": [
1557
- {
1558
- "$ref": "#/definitions/DecideRequestItemParametersJSON"
1559
- },
1560
- {
1561
- "$ref": "#/definitions/DecideRequestItemGroupParametersJSON"
1562
- }
1563
- ]
1595
+ "type": "string"
1564
1596
  }
1565
1597
  }
1566
1598
  },
1567
1599
  "required": [
1568
- "items",
1569
- "requestId"
1570
- ]
1600
+ "@type",
1601
+ "owner",
1602
+ "value"
1603
+ ],
1604
+ "additionalProperties": false
1571
1605
  },
1572
- "DecideRequestItemParametersJSON": {
1573
- "anyOf": [
1574
- {
1575
- "$ref": "#/definitions/AcceptRequestItemParametersJSON"
1606
+ "AbstractAttributeValueJSON": {
1607
+ "type": "object",
1608
+ "properties": {
1609
+ "@type": {
1610
+ "type": "string"
1576
1611
  },
1577
- {
1578
- "$ref": "#/definitions/RejectRequestItemParametersJSON"
1612
+ "@context": {
1613
+ "type": "string"
1614
+ },
1615
+ "@version": {
1616
+ "type": "string"
1579
1617
  }
1618
+ },
1619
+ "required": [
1620
+ "@type"
1580
1621
  ]
1581
1622
  },
1582
- "AcceptRequestItemParametersJSON": {
1623
+ "RelationshipAttributeJSON": {
1583
1624
  "type": "object",
1584
1625
  "properties": {
1585
- "accept": {
1586
- "type": "boolean",
1587
- "const": true
1626
+ "@type": {
1627
+ "type": "string"
1628
+ },
1629
+ "@context": {
1630
+ "type": "string"
1631
+ },
1632
+ "@version": {
1633
+ "type": "string"
1634
+ },
1635
+ "owner": {
1636
+ "type": "string"
1637
+ },
1638
+ "validFrom": {
1639
+ "type": "string"
1640
+ },
1641
+ "validTo": {
1642
+ "type": "string"
1643
+ },
1644
+ "value": {
1645
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
1646
+ },
1647
+ "key": {
1648
+ "type": "string"
1649
+ },
1650
+ "isTechnical": {
1651
+ "type": "boolean"
1652
+ },
1653
+ "confidentiality": {
1654
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
1588
1655
  }
1589
1656
  },
1590
1657
  "required": [
1591
- "accept"
1658
+ "@type",
1659
+ "confidentiality",
1660
+ "key",
1661
+ "owner",
1662
+ "value"
1592
1663
  ],
1593
1664
  "additionalProperties": false
1594
1665
  },
1595
- "RejectRequestItemParametersJSON": {
1666
+ "RelationshipAttributeConfidentiality": {
1667
+ "type": "string",
1668
+ "enum": [
1669
+ "public",
1670
+ "private",
1671
+ "protected"
1672
+ ]
1673
+ },
1674
+ "ProposeAttributeRequestItemJSON": {
1596
1675
  "type": "object",
1597
1676
  "properties": {
1598
- "accept": {
1599
- "type": "boolean",
1600
- "const": false
1677
+ "@type": {
1678
+ "type": "string"
1601
1679
  },
1602
- "code": {
1680
+ "@context": {
1603
1681
  "type": "string"
1604
1682
  },
1605
- "message": {
1683
+ "@version": {
1606
1684
  "type": "string"
1685
+ },
1686
+ "title": {
1687
+ "type": "string",
1688
+ "description": "The human-readable title of this item."
1689
+ },
1690
+ "description": {
1691
+ "type": "string",
1692
+ "description": "The human-readable description of this item."
1693
+ },
1694
+ "metadata": {
1695
+ "type": "object",
1696
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1697
+ },
1698
+ "mustBeAccepted": {
1699
+ "type": "boolean",
1700
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
1701
+ },
1702
+ "query": {
1703
+ "anyOf": [
1704
+ {
1705
+ "$ref": "#/definitions/IdentityAttributeQueryJSON"
1706
+ },
1707
+ {
1708
+ "$ref": "#/definitions/RelationshipAttributeQueryJSON"
1709
+ }
1710
+ ]
1711
+ },
1712
+ "attribute": {
1713
+ "anyOf": [
1714
+ {
1715
+ "$ref": "#/definitions/IdentityAttributeJSON"
1716
+ },
1717
+ {
1718
+ "$ref": "#/definitions/RelationshipAttributeJSON"
1719
+ }
1720
+ ]
1607
1721
  }
1608
1722
  },
1609
1723
  "required": [
1610
- "accept"
1724
+ "@type",
1725
+ "attribute",
1726
+ "mustBeAccepted",
1727
+ "query"
1611
1728
  ],
1612
1729
  "additionalProperties": false
1613
1730
  },
1614
- "DecideRequestItemGroupParametersJSON": {
1731
+ "IdentityAttributeQueryJSON": {
1615
1732
  "type": "object",
1616
1733
  "properties": {
1617
- "items": {
1734
+ "@type": {
1735
+ "type": "string"
1736
+ },
1737
+ "@context": {
1738
+ "type": "string"
1739
+ },
1740
+ "@version": {
1741
+ "type": "string"
1742
+ },
1743
+ "valueType": {
1744
+ "type": "string"
1745
+ },
1746
+ "validFrom": {
1747
+ "type": "string"
1748
+ },
1749
+ "validTo": {
1750
+ "type": "string"
1751
+ },
1752
+ "tags": {
1618
1753
  "type": "array",
1619
1754
  "items": {
1620
- "$ref": "#/definitions/DecideRequestItemParametersJSON"
1755
+ "type": "string"
1621
1756
  }
1622
1757
  }
1623
1758
  },
1759
+ "additionalProperties": false,
1624
1760
  "required": [
1625
- "items"
1626
- ],
1627
- "additionalProperties": false
1628
- }
1629
- }
1630
- };
1631
- exports.CheckPrerequisitesOfIncomingRequestRequest = {
1632
- "$schema": "http://json-schema.org/draft-07/schema#",
1633
- "$ref": "#/definitions/CheckPrerequisitesOfIncomingRequestRequest",
1634
- "definitions": {
1635
- "CheckPrerequisitesOfIncomingRequestRequest": {
1636
- "type": "object",
1637
- "properties": {
1638
- "requestId": {
1639
- "type": "string",
1640
- "pattern": "REQ[A-Za-z0-9]{17}"
1641
- }
1642
- },
1643
- "required": [
1644
- "requestId"
1645
- ],
1646
- "additionalProperties": false
1647
- }
1648
- }
1649
- };
1650
- exports.CompleteIncomingRequestRequest = {
1651
- "$schema": "http://json-schema.org/draft-07/schema#",
1652
- "$ref": "#/definitions/CompleteIncomingRequestRequest",
1653
- "definitions": {
1654
- "CompleteIncomingRequestRequest": {
1761
+ "@type",
1762
+ "valueType"
1763
+ ]
1764
+ },
1765
+ "RelationshipAttributeQueryJSON": {
1655
1766
  "type": "object",
1656
1767
  "properties": {
1657
- "requestId": {
1658
- "type": "string",
1659
- "pattern": "REQ[A-Za-z0-9]{17}"
1768
+ "@type": {
1769
+ "type": "string"
1660
1770
  },
1661
- "responseSourceId": {
1662
- "type": "string",
1663
- "pattern": "(MSG|RCH)[A-Za-z0-9]{17}"
1771
+ "@context": {
1772
+ "type": "string"
1773
+ },
1774
+ "@version": {
1775
+ "type": "string"
1776
+ },
1777
+ "valueType": {
1778
+ "type": "string"
1779
+ },
1780
+ "validFrom": {
1781
+ "type": "string"
1782
+ },
1783
+ "validTo": {
1784
+ "type": "string"
1785
+ },
1786
+ "key": {
1787
+ "type": "string"
1788
+ },
1789
+ "owner": {
1790
+ "type": "string"
1791
+ },
1792
+ "thirdParty": {
1793
+ "type": "string"
1794
+ },
1795
+ "attributeCreationHints": {
1796
+ "$ref": "#/definitions/RelationshipAttributeCreationHintsJSON"
1664
1797
  }
1665
1798
  },
1666
1799
  "required": [
1667
- "requestId",
1668
- "responseSourceId"
1800
+ "@type",
1801
+ "attributeCreationHints",
1802
+ "key",
1803
+ "owner",
1804
+ "valueType"
1669
1805
  ],
1670
1806
  "additionalProperties": false
1671
- }
1672
- }
1673
- };
1674
- exports.CompleteOutgoingRequestRequest = {
1675
- "$schema": "http://json-schema.org/draft-07/schema#",
1676
- "$ref": "#/definitions/CompleteOutgoingRequestRequest",
1677
- "definitions": {
1678
- "CompleteOutgoingRequestRequest": {
1807
+ },
1808
+ "RelationshipAttributeCreationHintsJSON": {
1679
1809
  "type": "object",
1680
1810
  "properties": {
1681
- "receivedResponse": {
1682
- "$ref": "#/definitions/ResponseJSON"
1811
+ "title": {
1812
+ "type": "string"
1683
1813
  },
1684
- "messageId": {
1685
- "type": "string",
1686
- "pattern": "MSG[A-Za-z0-9]{17}"
1814
+ "description": {
1815
+ "type": "string"
1816
+ },
1817
+ "valueHints": {
1818
+ "$ref": "#/definitions/ValueHintsJSON"
1819
+ },
1820
+ "isTechnical": {
1821
+ "type": "boolean"
1822
+ },
1823
+ "confidentiality": {
1824
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
1687
1825
  }
1688
1826
  },
1689
1827
  "required": [
1690
- "receivedResponse",
1691
- "messageId"
1828
+ "title",
1829
+ "confidentiality"
1692
1830
  ],
1693
1831
  "additionalProperties": false
1694
1832
  },
1695
- "ResponseJSON": {
1833
+ "ValueHintsJSON": {
1696
1834
  "type": "object",
1697
1835
  "properties": {
1698
1836
  "@type": {
@@ -1704,45 +1842,64 @@ exports.CompleteOutgoingRequestRequest = {
1704
1842
  "@version": {
1705
1843
  "type": "string"
1706
1844
  },
1707
- "result": {
1708
- "$ref": "#/definitions/ResponseResult"
1845
+ "editHelp": {
1846
+ "type": "string"
1709
1847
  },
1710
- "requestId": {
1848
+ "min": {
1849
+ "type": "number"
1850
+ },
1851
+ "max": {
1852
+ "type": "number"
1853
+ },
1854
+ "pattern": {
1711
1855
  "type": "string"
1712
1856
  },
1713
- "items": {
1857
+ "values": {
1714
1858
  "type": "array",
1715
1859
  "items": {
1716
- "anyOf": [
1717
- {
1718
- "$ref": "#/definitions/ResponseItemGroupJSON"
1719
- },
1720
- {
1721
- "$ref": "#/definitions/ResponseItemJSON"
1722
- }
1723
- ]
1860
+ "$ref": "#/definitions/ValueHintsValueJSON"
1724
1861
  }
1725
1862
  },
1726
- "metadata": {
1727
- "type": "object"
1863
+ "defaultValue": {
1864
+ "type": [
1865
+ "string",
1866
+ "number",
1867
+ "boolean"
1868
+ ]
1869
+ },
1870
+ "propertyHints": {
1871
+ "type": "object",
1872
+ "additionalProperties": {
1873
+ "$ref": "#/definitions/ValueHintsJSON"
1874
+ }
1728
1875
  }
1729
1876
  },
1877
+ "additionalProperties": false,
1730
1878
  "required": [
1731
- "@type",
1732
- "items",
1733
- "requestId",
1734
- "result"
1879
+ "@type"
1880
+ ]
1881
+ },
1882
+ "ValueHintsValueJSON": {
1883
+ "type": "object",
1884
+ "properties": {
1885
+ "key": {
1886
+ "type": [
1887
+ "string",
1888
+ "number",
1889
+ "boolean"
1890
+ ]
1891
+ },
1892
+ "displayName": {
1893
+ "type": "string"
1894
+ }
1895
+ },
1896
+ "required": [
1897
+ "key",
1898
+ "displayName"
1735
1899
  ],
1736
1900
  "additionalProperties": false
1737
1901
  },
1738
- "ResponseResult": {
1739
- "type": "string",
1740
- "enum": [
1741
- "Accepted",
1742
- "Rejected"
1743
- ]
1744
- },
1745
- "ResponseItemGroupJSON": {
1902
+ "ReadAttributeRequestItemJSON": {
1746
1903
  "type": "object",
1747
1904
  "properties": {
1748
1905
  "@type": {
@@ -1754,23 +1911,34 @@ exports.CompleteOutgoingRequestRequest = {
1754
1911
  "@version": {
1755
1912
  "type": "string"
1756
1913
  },
1757
- "items": {
1758
- "type": "array",
1759
- "items": {
1760
- "$ref": "#/definitions/ResponseItemJSON"
1761
- }
1914
+ "title": {
1915
+ "type": "string",
1916
+ "description": "The human-readable title of this item."
1917
+ },
1918
+ "description": {
1919
+ "type": "string",
1920
+ "description": "The human-readable description of this item."
1762
1921
  },
1763
1922
  "metadata": {
1764
- "type": "object"
1923
+ "type": "object",
1924
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1925
+ },
1926
+ "mustBeAccepted": {
1927
+ "type": "boolean",
1928
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
1929
+ },
1930
+ "query": {
1931
+ "$ref": "#/definitions/AbstractAttributeQueryJSON"
1765
1932
  }
1766
1933
  },
1767
1934
  "required": [
1768
1935
  "@type",
1769
- "items"
1936
+ "mustBeAccepted",
1937
+ "query"
1770
1938
  ],
1771
1939
  "additionalProperties": false
1772
1940
  },
1773
- "ResponseItemJSON": {
1941
+ "AbstractAttributeQueryJSON": {
1774
1942
  "type": "object",
1775
1943
  "properties": {
1776
1944
  "@type": {
@@ -1782,336 +1950,1927 @@ exports.CompleteOutgoingRequestRequest = {
1782
1950
  "@version": {
1783
1951
  "type": "string"
1784
1952
  },
1785
- "result": {
1786
- "$ref": "#/definitions/ResponseItemResult"
1953
+ "valueType": {
1954
+ "type": "string"
1787
1955
  },
1788
- "metadata": {
1789
- "type": "object"
1956
+ "validFrom": {
1957
+ "type": "string"
1958
+ },
1959
+ "validTo": {
1960
+ "type": "string"
1790
1961
  }
1791
1962
  },
1792
1963
  "required": [
1793
1964
  "@type",
1794
- "result"
1965
+ "valueType"
1795
1966
  ],
1796
1967
  "additionalProperties": false
1797
1968
  },
1798
- "ResponseItemResult": {
1799
- "type": "string",
1800
- "enum": [
1801
- "Accepted",
1802
- "Rejected",
1803
- "Error"
1804
- ]
1805
- }
1806
- }
1807
- };
1808
- exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = {
1809
- "$schema": "http://json-schema.org/draft-07/schema#",
1810
- "$ref": "#/definitions/CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest",
1811
- "definitions": {
1812
- "CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest": {
1969
+ "ShareAttributeRequestItemJSON": {
1813
1970
  "type": "object",
1814
1971
  "properties": {
1815
- "templateId": {
1816
- "type": "string",
1817
- "pattern": "RLT[A-Za-z0-9]{17}"
1972
+ "@type": {
1973
+ "type": "string"
1818
1974
  },
1819
- "relationshipChangeId": {
1820
- "type": "string",
1821
- "pattern": "RCH[A-Za-z0-9]{17}"
1822
- }
1823
- },
1824
- "required": [
1825
- "templateId",
1975
+ "@context": {
1976
+ "type": "string"
1977
+ },
1978
+ "@version": {
1979
+ "type": "string"
1980
+ },
1981
+ "title": {
1982
+ "type": "string",
1983
+ "description": "The human-readable title of this item."
1984
+ },
1985
+ "description": {
1986
+ "type": "string",
1987
+ "description": "The human-readable description of this item."
1988
+ },
1989
+ "metadata": {
1990
+ "type": "object",
1991
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
1992
+ },
1993
+ "mustBeAccepted": {
1994
+ "type": "boolean",
1995
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
1996
+ },
1997
+ "attributeId": {
1998
+ "type": "string"
1999
+ },
2000
+ "shareWith": {
2001
+ "type": "string"
2002
+ }
2003
+ },
2004
+ "required": [
2005
+ "@type",
2006
+ "attributeId",
2007
+ "mustBeAccepted",
2008
+ "shareWith"
2009
+ ],
2010
+ "additionalProperties": false
2011
+ },
2012
+ "IRequestItemGroup": {
2013
+ "type": "object",
2014
+ "properties": {
2015
+ "title": {
2016
+ "type": "string",
2017
+ "description": "The human-readable title of this group."
2018
+ },
2019
+ "description": {
2020
+ "type": "string",
2021
+ "description": "The human-readable description of this group."
2022
+ },
2023
+ "mustBeAccepted": {
2024
+ "type": "boolean",
2025
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
2026
+ },
2027
+ "metadata": {
2028
+ "type": "object",
2029
+ "description": "This property can be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2030
+ },
2031
+ "items": {
2032
+ "type": "array",
2033
+ "items": {
2034
+ "$ref": "#/definitions/IRequestItemDerivations"
2035
+ },
2036
+ "description": "The items of this group."
2037
+ }
2038
+ },
2039
+ "required": [
2040
+ "mustBeAccepted",
2041
+ "items"
2042
+ ],
2043
+ "additionalProperties": false,
2044
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
2045
+ },
2046
+ "IRequestItemDerivations": {
2047
+ "anyOf": [
2048
+ {
2049
+ "$ref": "#/definitions/IRequestItem"
2050
+ },
2051
+ {
2052
+ "$ref": "#/definitions/ICreateAttributeRequestItem"
2053
+ },
2054
+ {
2055
+ "$ref": "#/definitions/IProposeAttributeRequestItem"
2056
+ },
2057
+ {
2058
+ "$ref": "#/definitions/IReadAttributeRequestItem"
2059
+ },
2060
+ {
2061
+ "$ref": "#/definitions/IShareAttributeRequestItem"
2062
+ }
2063
+ ]
2064
+ },
2065
+ "IRequestItem": {
2066
+ "type": "object",
2067
+ "properties": {
2068
+ "title": {
2069
+ "type": "string",
2070
+ "description": "The human-readable title of this item."
2071
+ },
2072
+ "description": {
2073
+ "type": "string",
2074
+ "description": "The human-readable description of this item."
2075
+ },
2076
+ "metadata": {
2077
+ "type": "object",
2078
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2079
+ },
2080
+ "mustBeAccepted": {
2081
+ "type": "boolean",
2082
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
2083
+ }
2084
+ },
2085
+ "required": [
2086
+ "mustBeAccepted"
2087
+ ],
2088
+ "additionalProperties": false
2089
+ },
2090
+ "ICreateAttributeRequestItem": {
2091
+ "type": "object",
2092
+ "properties": {
2093
+ "title": {
2094
+ "type": "string",
2095
+ "description": "The human-readable title of this item."
2096
+ },
2097
+ "description": {
2098
+ "type": "string",
2099
+ "description": "The human-readable description of this item."
2100
+ },
2101
+ "metadata": {
2102
+ "type": "object",
2103
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2104
+ },
2105
+ "mustBeAccepted": {
2106
+ "type": "boolean",
2107
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
2108
+ },
2109
+ "attribute": {
2110
+ "anyOf": [
2111
+ {
2112
+ "$ref": "#/definitions/IIdentityAttribute"
2113
+ },
2114
+ {
2115
+ "$ref": "#/definitions/IRelationshipAttribute"
2116
+ }
2117
+ ]
2118
+ },
2119
+ "sourceAttributeId": {
2120
+ "$ref": "#/definitions/ICoreId"
2121
+ }
2122
+ },
2123
+ "required": [
2124
+ "attribute",
2125
+ "mustBeAccepted"
2126
+ ],
2127
+ "additionalProperties": false
2128
+ },
2129
+ "IIdentityAttribute": {
2130
+ "type": "object",
2131
+ "properties": {
2132
+ "owner": {
2133
+ "$ref": "#/definitions/ICoreAddress"
2134
+ },
2135
+ "validFrom": {
2136
+ "$ref": "#/definitions/ICoreDate"
2137
+ },
2138
+ "validTo": {
2139
+ "$ref": "#/definitions/ICoreDate"
2140
+ },
2141
+ "value": {
2142
+ "$ref": "#/definitions/IAbstractAttributeValue"
2143
+ },
2144
+ "tags": {
2145
+ "type": "array",
2146
+ "items": {
2147
+ "type": "string"
2148
+ }
2149
+ }
2150
+ },
2151
+ "required": [
2152
+ "owner",
2153
+ "value"
2154
+ ],
2155
+ "additionalProperties": false
2156
+ },
2157
+ "ICoreAddress": {
2158
+ "type": "object",
2159
+ "properties": {
2160
+ "address": {
2161
+ "type": "string"
2162
+ }
2163
+ },
2164
+ "required": [
2165
+ "address"
2166
+ ],
2167
+ "additionalProperties": false
2168
+ },
2169
+ "IAbstractAttributeValue": {
2170
+ "type": "object",
2171
+ "additionalProperties": false,
2172
+ "properties": {}
2173
+ },
2174
+ "IRelationshipAttribute": {
2175
+ "type": "object",
2176
+ "properties": {
2177
+ "owner": {
2178
+ "$ref": "#/definitions/ICoreAddress"
2179
+ },
2180
+ "validFrom": {
2181
+ "$ref": "#/definitions/ICoreDate"
2182
+ },
2183
+ "validTo": {
2184
+ "$ref": "#/definitions/ICoreDate"
2185
+ },
2186
+ "value": {
2187
+ "$ref": "#/definitions/IAbstractAttributeValue"
2188
+ },
2189
+ "key": {
2190
+ "type": "string"
2191
+ },
2192
+ "isTechnical": {
2193
+ "type": "boolean"
2194
+ },
2195
+ "confidentiality": {
2196
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2197
+ }
2198
+ },
2199
+ "required": [
2200
+ "confidentiality",
2201
+ "key",
2202
+ "owner",
2203
+ "value"
2204
+ ],
2205
+ "additionalProperties": false
2206
+ },
2207
+ "ICoreId": {
2208
+ "type": "object",
2209
+ "properties": {
2210
+ "id": {
2211
+ "type": "string"
2212
+ }
2213
+ },
2214
+ "required": [
2215
+ "id"
2216
+ ],
2217
+ "additionalProperties": false
2218
+ },
2219
+ "IProposeAttributeRequestItem": {
2220
+ "type": "object",
2221
+ "properties": {
2222
+ "title": {
2223
+ "type": "string",
2224
+ "description": "The human-readable title of this item."
2225
+ },
2226
+ "description": {
2227
+ "type": "string",
2228
+ "description": "The human-readable description of this item."
2229
+ },
2230
+ "metadata": {
2231
+ "type": "object",
2232
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2233
+ },
2234
+ "mustBeAccepted": {
2235
+ "type": "boolean",
2236
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
2237
+ },
2238
+ "query": {
2239
+ "anyOf": [
2240
+ {
2241
+ "$ref": "#/definitions/IIdentityAttributeQuery"
2242
+ },
2243
+ {
2244
+ "$ref": "#/definitions/IRelationshipAttributeQuery"
2245
+ }
2246
+ ]
2247
+ },
2248
+ "attribute": {
2249
+ "anyOf": [
2250
+ {
2251
+ "$ref": "#/definitions/IIdentityAttribute"
2252
+ },
2253
+ {
2254
+ "$ref": "#/definitions/IRelationshipAttribute"
2255
+ }
2256
+ ]
2257
+ }
2258
+ },
2259
+ "required": [
2260
+ "attribute",
2261
+ "mustBeAccepted",
2262
+ "query"
2263
+ ],
2264
+ "additionalProperties": false
2265
+ },
2266
+ "IIdentityAttributeQuery": {
2267
+ "type": "object",
2268
+ "properties": {
2269
+ "valueType": {
2270
+ "type": "string"
2271
+ },
2272
+ "validFrom": {
2273
+ "$ref": "#/definitions/ICoreDate"
2274
+ },
2275
+ "validTo": {
2276
+ "$ref": "#/definitions/ICoreDate"
2277
+ },
2278
+ "tags": {
2279
+ "type": "array",
2280
+ "items": {
2281
+ "type": "string"
2282
+ }
2283
+ }
2284
+ },
2285
+ "additionalProperties": false,
2286
+ "required": [
2287
+ "valueType"
2288
+ ]
2289
+ },
2290
+ "IRelationshipAttributeQuery": {
2291
+ "type": "object",
2292
+ "properties": {
2293
+ "valueType": {
2294
+ "type": "string"
2295
+ },
2296
+ "validFrom": {
2297
+ "$ref": "#/definitions/ICoreDate"
2298
+ },
2299
+ "validTo": {
2300
+ "$ref": "#/definitions/ICoreDate"
2301
+ },
2302
+ "key": {
2303
+ "type": "string"
2304
+ },
2305
+ "owner": {
2306
+ "$ref": "#/definitions/ICoreAddress"
2307
+ },
2308
+ "thirdParty": {
2309
+ "$ref": "#/definitions/ICoreAddress"
2310
+ },
2311
+ "attributeCreationHints": {
2312
+ "$ref": "#/definitions/IRelationshipAttributeCreationHints"
2313
+ }
2314
+ },
2315
+ "required": [
2316
+ "attributeCreationHints",
2317
+ "key",
2318
+ "owner",
2319
+ "valueType"
2320
+ ],
2321
+ "additionalProperties": false
2322
+ },
2323
+ "IRelationshipAttributeCreationHints": {
2324
+ "type": "object",
2325
+ "properties": {
2326
+ "title": {
2327
+ "type": "string"
2328
+ },
2329
+ "description": {
2330
+ "type": "string"
2331
+ },
2332
+ "valueHints": {
2333
+ "$ref": "#/definitions/IValueHints"
2334
+ },
2335
+ "isTechnical": {
2336
+ "type": "boolean"
2337
+ },
2338
+ "confidentiality": {
2339
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2340
+ }
2341
+ },
2342
+ "required": [
2343
+ "title",
2344
+ "confidentiality"
2345
+ ],
2346
+ "additionalProperties": false
2347
+ },
2348
+ "IValueHints": {
2349
+ "type": "object",
2350
+ "properties": {
2351
+ "editHelp": {
2352
+ "type": "string"
2353
+ },
2354
+ "min": {
2355
+ "type": "number"
2356
+ },
2357
+ "max": {
2358
+ "type": "number"
2359
+ },
2360
+ "pattern": {
2361
+ "type": "string"
2362
+ },
2363
+ "values": {
2364
+ "type": "array",
2365
+ "items": {
2366
+ "$ref": "#/definitions/IValueHintsValue"
2367
+ }
2368
+ },
2369
+ "defaultValue": {
2370
+ "type": [
2371
+ "string",
2372
+ "number",
2373
+ "boolean"
2374
+ ]
2375
+ },
2376
+ "propertyHints": {
2377
+ "type": "object",
2378
+ "additionalProperties": {
2379
+ "$ref": "#/definitions/IValueHints"
2380
+ }
2381
+ }
2382
+ },
2383
+ "additionalProperties": false
2384
+ },
2385
+ "IValueHintsValue": {
2386
+ "type": "object",
2387
+ "properties": {
2388
+ "key": {
2389
+ "type": [
2390
+ "string",
2391
+ "number",
2392
+ "boolean"
2393
+ ]
2394
+ },
2395
+ "displayName": {
2396
+ "type": "string"
2397
+ }
2398
+ },
2399
+ "required": [
2400
+ "key",
2401
+ "displayName"
2402
+ ],
2403
+ "additionalProperties": false
2404
+ },
2405
+ "IReadAttributeRequestItem": {
2406
+ "type": "object",
2407
+ "properties": {
2408
+ "title": {
2409
+ "type": "string",
2410
+ "description": "The human-readable title of this item."
2411
+ },
2412
+ "description": {
2413
+ "type": "string",
2414
+ "description": "The human-readable description of this item."
2415
+ },
2416
+ "metadata": {
2417
+ "type": "object",
2418
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2419
+ },
2420
+ "mustBeAccepted": {
2421
+ "type": "boolean",
2422
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
2423
+ },
2424
+ "query": {
2425
+ "$ref": "#/definitions/IAbstractAttributeQuery"
2426
+ }
2427
+ },
2428
+ "required": [
2429
+ "mustBeAccepted",
2430
+ "query"
2431
+ ],
2432
+ "additionalProperties": false
2433
+ },
2434
+ "IAbstractAttributeQuery": {
2435
+ "type": "object",
2436
+ "properties": {
2437
+ "valueType": {
2438
+ "type": "string"
2439
+ },
2440
+ "validFrom": {
2441
+ "$ref": "#/definitions/ICoreDate"
2442
+ },
2443
+ "validTo": {
2444
+ "$ref": "#/definitions/ICoreDate"
2445
+ }
2446
+ },
2447
+ "required": [
2448
+ "valueType"
2449
+ ],
2450
+ "additionalProperties": false
2451
+ },
2452
+ "IShareAttributeRequestItem": {
2453
+ "type": "object",
2454
+ "properties": {
2455
+ "title": {
2456
+ "type": "string",
2457
+ "description": "The human-readable title of this item."
2458
+ },
2459
+ "description": {
2460
+ "type": "string",
2461
+ "description": "The human-readable description of this item."
2462
+ },
2463
+ "metadata": {
2464
+ "type": "object",
2465
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2466
+ },
2467
+ "mustBeAccepted": {
2468
+ "type": "boolean",
2469
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItem RequestItem } can only be accepted if the parent group is accepted as well."
2470
+ },
2471
+ "attributeId": {
2472
+ "$ref": "#/definitions/ICoreId"
2473
+ },
2474
+ "shareWith": {
2475
+ "$ref": "#/definitions/ICoreAddress"
2476
+ }
2477
+ },
2478
+ "required": [
2479
+ "attributeId",
2480
+ "mustBeAccepted",
2481
+ "shareWith"
2482
+ ],
2483
+ "additionalProperties": false
2484
+ }
2485
+ }
2486
+ };
2487
+ exports.RejectIncomingRequestRequest = {
2488
+ "$schema": "http://json-schema.org/draft-07/schema#",
2489
+ "$ref": "#/definitions/RejectIncomingRequestRequest",
2490
+ "definitions": {
2491
+ "RejectIncomingRequestRequest": {
2492
+ "type": "object",
2493
+ "additionalProperties": false,
2494
+ "properties": {
2495
+ "requestId": {
2496
+ "type": "string"
2497
+ },
2498
+ "items": {
2499
+ "type": "array",
2500
+ "items": {
2501
+ "anyOf": [
2502
+ {
2503
+ "$ref": "#/definitions/DecideRequestItemParametersJSON"
2504
+ },
2505
+ {
2506
+ "$ref": "#/definitions/DecideRequestItemGroupParametersJSON"
2507
+ }
2508
+ ]
2509
+ }
2510
+ }
2511
+ },
2512
+ "required": [
2513
+ "items",
2514
+ "requestId"
2515
+ ]
2516
+ },
2517
+ "DecideRequestItemParametersJSON": {
2518
+ "anyOf": [
2519
+ {
2520
+ "$ref": "#/definitions/AcceptRequestItemParametersJSON"
2521
+ },
2522
+ {
2523
+ "$ref": "#/definitions/RejectRequestItemParametersJSON"
2524
+ }
2525
+ ]
2526
+ },
2527
+ "AcceptRequestItemParametersJSON": {
2528
+ "type": "object",
2529
+ "properties": {
2530
+ "accept": {
2531
+ "type": "boolean",
2532
+ "const": true
2533
+ }
2534
+ },
2535
+ "required": [
2536
+ "accept"
2537
+ ],
2538
+ "additionalProperties": false
2539
+ },
2540
+ "RejectRequestItemParametersJSON": {
2541
+ "type": "object",
2542
+ "properties": {
2543
+ "accept": {
2544
+ "type": "boolean",
2545
+ "const": false
2546
+ },
2547
+ "code": {
2548
+ "type": "string"
2549
+ },
2550
+ "message": {
2551
+ "type": "string"
2552
+ }
2553
+ },
2554
+ "required": [
2555
+ "accept"
2556
+ ],
2557
+ "additionalProperties": false
2558
+ },
2559
+ "DecideRequestItemGroupParametersJSON": {
2560
+ "type": "object",
2561
+ "properties": {
2562
+ "items": {
2563
+ "type": "array",
2564
+ "items": {
2565
+ "$ref": "#/definitions/DecideRequestItemParametersJSON"
2566
+ }
2567
+ }
2568
+ },
2569
+ "required": [
2570
+ "items"
2571
+ ],
2572
+ "additionalProperties": false
2573
+ }
2574
+ }
2575
+ };
2576
+ exports.CheckPrerequisitesOfIncomingRequestRequest = {
2577
+ "$schema": "http://json-schema.org/draft-07/schema#",
2578
+ "$ref": "#/definitions/CheckPrerequisitesOfIncomingRequestRequest",
2579
+ "definitions": {
2580
+ "CheckPrerequisitesOfIncomingRequestRequest": {
2581
+ "type": "object",
2582
+ "properties": {
2583
+ "requestId": {
2584
+ "type": "string",
2585
+ "pattern": "REQ[A-Za-z0-9]{17}"
2586
+ }
2587
+ },
2588
+ "required": [
2589
+ "requestId"
2590
+ ],
2591
+ "additionalProperties": false
2592
+ }
2593
+ }
2594
+ };
2595
+ exports.CompleteIncomingRequestRequest = {
2596
+ "$schema": "http://json-schema.org/draft-07/schema#",
2597
+ "$ref": "#/definitions/CompleteIncomingRequestRequest",
2598
+ "definitions": {
2599
+ "CompleteIncomingRequestRequest": {
2600
+ "type": "object",
2601
+ "properties": {
2602
+ "requestId": {
2603
+ "type": "string",
2604
+ "pattern": "REQ[A-Za-z0-9]{17}"
2605
+ },
2606
+ "responseSourceId": {
2607
+ "type": "string",
2608
+ "pattern": "(MSG|RCH)[A-Za-z0-9]{17}"
2609
+ }
2610
+ },
2611
+ "required": [
2612
+ "requestId",
2613
+ "responseSourceId"
2614
+ ],
2615
+ "additionalProperties": false
2616
+ }
2617
+ }
2618
+ };
2619
+ exports.CompleteOutgoingRequestRequest = {
2620
+ "$schema": "http://json-schema.org/draft-07/schema#",
2621
+ "$ref": "#/definitions/CompleteOutgoingRequestRequest",
2622
+ "definitions": {
2623
+ "CompleteOutgoingRequestRequest": {
2624
+ "type": "object",
2625
+ "properties": {
2626
+ "receivedResponse": {
2627
+ "$ref": "#/definitions/ResponseJSON"
2628
+ },
2629
+ "messageId": {
2630
+ "type": "string",
2631
+ "pattern": "MSG[A-Za-z0-9]{17}"
2632
+ }
2633
+ },
2634
+ "required": [
2635
+ "receivedResponse",
2636
+ "messageId"
2637
+ ],
2638
+ "additionalProperties": false
2639
+ },
2640
+ "ResponseJSON": {
2641
+ "type": "object",
2642
+ "properties": {
2643
+ "@type": {
2644
+ "type": "string"
2645
+ },
2646
+ "@context": {
2647
+ "type": "string"
2648
+ },
2649
+ "@version": {
2650
+ "type": "string"
2651
+ },
2652
+ "result": {
2653
+ "$ref": "#/definitions/ResponseResult"
2654
+ },
2655
+ "requestId": {
2656
+ "type": "string"
2657
+ },
2658
+ "items": {
2659
+ "type": "array",
2660
+ "items": {
2661
+ "anyOf": [
2662
+ {
2663
+ "$ref": "#/definitions/ResponseItemGroupJSON"
2664
+ },
2665
+ {
2666
+ "$ref": "#/definitions/ResponseItemJSONDerivations"
2667
+ }
2668
+ ]
2669
+ }
2670
+ }
2671
+ },
2672
+ "required": [
2673
+ "@type",
2674
+ "items",
2675
+ "requestId",
2676
+ "result"
2677
+ ],
2678
+ "additionalProperties": false
2679
+ },
2680
+ "ResponseResult": {
2681
+ "type": "string",
2682
+ "enum": [
2683
+ "Accepted",
2684
+ "Rejected"
2685
+ ]
2686
+ },
2687
+ "ResponseItemGroupJSON": {
2688
+ "type": "object",
2689
+ "properties": {
2690
+ "@type": {
2691
+ "type": "string"
2692
+ },
2693
+ "@context": {
2694
+ "type": "string"
2695
+ },
2696
+ "@version": {
2697
+ "type": "string"
2698
+ },
2699
+ "items": {
2700
+ "type": "array",
2701
+ "items": {
2702
+ "$ref": "#/definitions/ResponseItemJSONDerivations"
2703
+ }
2704
+ }
2705
+ },
2706
+ "required": [
2707
+ "@type",
2708
+ "items"
2709
+ ],
2710
+ "additionalProperties": false
2711
+ },
2712
+ "ResponseItemJSONDerivations": {
2713
+ "anyOf": [
2714
+ {
2715
+ "$ref": "#/definitions/AcceptResponseItemJSONDerivations"
2716
+ },
2717
+ {
2718
+ "$ref": "#/definitions/RejectResponseItemJSONDerivations"
2719
+ },
2720
+ {
2721
+ "$ref": "#/definitions/ErrorResponseItemJSONDerivations"
2722
+ }
2723
+ ]
2724
+ },
2725
+ "AcceptResponseItemJSONDerivations": {
2726
+ "anyOf": [
2727
+ {
2728
+ "$ref": "#/definitions/AcceptResponseItemJSON"
2729
+ },
2730
+ {
2731
+ "$ref": "#/definitions/CreateAttributeAcceptResponseItemJSON"
2732
+ },
2733
+ {
2734
+ "$ref": "#/definitions/ProposeAttributeAcceptResponseItemJSON"
2735
+ },
2736
+ {
2737
+ "$ref": "#/definitions/ReadAttributeAcceptResponseItemJSON"
2738
+ }
2739
+ ]
2740
+ },
2741
+ "AcceptResponseItemJSON": {
2742
+ "type": "object",
2743
+ "properties": {
2744
+ "@type": {
2745
+ "type": "string"
2746
+ },
2747
+ "@context": {
2748
+ "type": "string"
2749
+ },
2750
+ "@version": {
2751
+ "type": "string"
2752
+ },
2753
+ "result": {
2754
+ "type": "string",
2755
+ "const": "Accepted"
2756
+ }
2757
+ },
2758
+ "required": [
2759
+ "@type",
2760
+ "result"
2761
+ ],
2762
+ "additionalProperties": false
2763
+ },
2764
+ "CreateAttributeAcceptResponseItemJSON": {
2765
+ "type": "object",
2766
+ "properties": {
2767
+ "@type": {
2768
+ "type": "string"
2769
+ },
2770
+ "@context": {
2771
+ "type": "string"
2772
+ },
2773
+ "@version": {
2774
+ "type": "string"
2775
+ },
2776
+ "result": {
2777
+ "type": "string",
2778
+ "const": "Accepted"
2779
+ },
2780
+ "attributeId": {
2781
+ "type": "string"
2782
+ }
2783
+ },
2784
+ "required": [
2785
+ "@type",
2786
+ "attributeId",
2787
+ "result"
2788
+ ],
2789
+ "additionalProperties": false
2790
+ },
2791
+ "ProposeAttributeAcceptResponseItemJSON": {
2792
+ "type": "object",
2793
+ "properties": {
2794
+ "@type": {
2795
+ "type": "string"
2796
+ },
2797
+ "@context": {
2798
+ "type": "string"
2799
+ },
2800
+ "@version": {
2801
+ "type": "string"
2802
+ },
2803
+ "result": {
2804
+ "type": "string",
2805
+ "const": "Accepted"
2806
+ },
2807
+ "attributeId": {
2808
+ "type": "string"
2809
+ },
2810
+ "attribute": {
2811
+ "anyOf": [
2812
+ {
2813
+ "$ref": "#/definitions/IdentityAttributeJSON"
2814
+ },
2815
+ {
2816
+ "$ref": "#/definitions/RelationshipAttributeJSON"
2817
+ }
2818
+ ]
2819
+ }
2820
+ },
2821
+ "required": [
2822
+ "@type",
2823
+ "attribute",
2824
+ "attributeId",
2825
+ "result"
2826
+ ],
2827
+ "additionalProperties": false
2828
+ },
2829
+ "IdentityAttributeJSON": {
2830
+ "type": "object",
2831
+ "properties": {
2832
+ "@type": {
2833
+ "type": "string"
2834
+ },
2835
+ "@context": {
2836
+ "type": "string"
2837
+ },
2838
+ "@version": {
2839
+ "type": "string"
2840
+ },
2841
+ "owner": {
2842
+ "type": "string"
2843
+ },
2844
+ "validFrom": {
2845
+ "type": "string"
2846
+ },
2847
+ "validTo": {
2848
+ "type": "string"
2849
+ },
2850
+ "value": {
2851
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
2852
+ },
2853
+ "tags": {
2854
+ "type": "array",
2855
+ "items": {
2856
+ "type": "string"
2857
+ }
2858
+ }
2859
+ },
2860
+ "required": [
2861
+ "@type",
2862
+ "owner",
2863
+ "value"
2864
+ ],
2865
+ "additionalProperties": false
2866
+ },
2867
+ "AbstractAttributeValueJSON": {
2868
+ "type": "object",
2869
+ "properties": {
2870
+ "@type": {
2871
+ "type": "string"
2872
+ },
2873
+ "@context": {
2874
+ "type": "string"
2875
+ },
2876
+ "@version": {
2877
+ "type": "string"
2878
+ }
2879
+ },
2880
+ "required": [
2881
+ "@type"
2882
+ ]
2883
+ },
2884
+ "RelationshipAttributeJSON": {
2885
+ "type": "object",
2886
+ "properties": {
2887
+ "@type": {
2888
+ "type": "string"
2889
+ },
2890
+ "@context": {
2891
+ "type": "string"
2892
+ },
2893
+ "@version": {
2894
+ "type": "string"
2895
+ },
2896
+ "owner": {
2897
+ "type": "string"
2898
+ },
2899
+ "validFrom": {
2900
+ "type": "string"
2901
+ },
2902
+ "validTo": {
2903
+ "type": "string"
2904
+ },
2905
+ "value": {
2906
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
2907
+ },
2908
+ "key": {
2909
+ "type": "string"
2910
+ },
2911
+ "isTechnical": {
2912
+ "type": "boolean"
2913
+ },
2914
+ "confidentiality": {
2915
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2916
+ }
2917
+ },
2918
+ "required": [
2919
+ "@type",
2920
+ "confidentiality",
2921
+ "key",
2922
+ "owner",
2923
+ "value"
2924
+ ],
2925
+ "additionalProperties": false
2926
+ },
2927
+ "RelationshipAttributeConfidentiality": {
2928
+ "type": "string",
2929
+ "enum": [
2930
+ "public",
2931
+ "private",
2932
+ "protected"
2933
+ ]
2934
+ },
2935
+ "ReadAttributeAcceptResponseItemJSON": {
2936
+ "type": "object",
2937
+ "properties": {
2938
+ "@type": {
2939
+ "type": "string"
2940
+ },
2941
+ "@context": {
2942
+ "type": "string"
2943
+ },
2944
+ "@version": {
2945
+ "type": "string"
2946
+ },
2947
+ "result": {
2948
+ "type": "string",
2949
+ "const": "Accepted"
2950
+ },
2951
+ "attributeId": {
2952
+ "type": "string"
2953
+ },
2954
+ "attribute": {
2955
+ "anyOf": [
2956
+ {
2957
+ "$ref": "#/definitions/IdentityAttributeJSON"
2958
+ },
2959
+ {
2960
+ "$ref": "#/definitions/RelationshipAttributeJSON"
2961
+ }
2962
+ ]
2963
+ }
2964
+ },
2965
+ "required": [
2966
+ "@type",
2967
+ "attribute",
2968
+ "attributeId",
2969
+ "result"
2970
+ ],
2971
+ "additionalProperties": false
2972
+ },
2973
+ "RejectResponseItemJSONDerivations": {
2974
+ "$ref": "#/definitions/RejectResponseItemJSON"
2975
+ },
2976
+ "RejectResponseItemJSON": {
2977
+ "type": "object",
2978
+ "properties": {
2979
+ "@type": {
2980
+ "type": "string"
2981
+ },
2982
+ "@context": {
2983
+ "type": "string"
2984
+ },
2985
+ "@version": {
2986
+ "type": "string"
2987
+ },
2988
+ "result": {
2989
+ "type": "string",
2990
+ "const": "Rejected"
2991
+ },
2992
+ "code": {
2993
+ "type": "string"
2994
+ },
2995
+ "message": {
2996
+ "type": "string"
2997
+ }
2998
+ },
2999
+ "required": [
3000
+ "@type",
3001
+ "result"
3002
+ ],
3003
+ "additionalProperties": false
3004
+ },
3005
+ "ErrorResponseItemJSONDerivations": {
3006
+ "$ref": "#/definitions/ErrorResponseItemJSON"
3007
+ },
3008
+ "ErrorResponseItemJSON": {
3009
+ "type": "object",
3010
+ "properties": {
3011
+ "@type": {
3012
+ "type": "string"
3013
+ },
3014
+ "@context": {
3015
+ "type": "string"
3016
+ },
3017
+ "@version": {
3018
+ "type": "string"
3019
+ },
3020
+ "result": {
3021
+ "type": "string",
3022
+ "const": "Error"
3023
+ },
3024
+ "code": {
3025
+ "type": "string"
3026
+ },
3027
+ "message": {
3028
+ "type": "string"
3029
+ }
3030
+ },
3031
+ "required": [
3032
+ "@type",
3033
+ "code",
3034
+ "message",
3035
+ "result"
3036
+ ],
3037
+ "additionalProperties": false
3038
+ }
3039
+ }
3040
+ };
3041
+ exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = {
3042
+ "$schema": "http://json-schema.org/draft-07/schema#",
3043
+ "$ref": "#/definitions/CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest",
3044
+ "definitions": {
3045
+ "CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest": {
3046
+ "type": "object",
3047
+ "properties": {
3048
+ "templateId": {
3049
+ "type": "string",
3050
+ "pattern": "RLT[A-Za-z0-9]{17}"
3051
+ },
3052
+ "relationshipChangeId": {
3053
+ "type": "string",
3054
+ "pattern": "RCH[A-Za-z0-9]{17}"
3055
+ }
3056
+ },
3057
+ "required": [
3058
+ "templateId",
1826
3059
  "relationshipChangeId"
1827
3060
  ],
1828
3061
  "additionalProperties": false
1829
3062
  }
1830
3063
  }
1831
3064
  };
1832
- exports.GetIncomingRequestRequest = {
3065
+ exports.GetIncomingRequestRequest = {
3066
+ "$schema": "http://json-schema.org/draft-07/schema#",
3067
+ "$ref": "#/definitions/GetIncomingRequestRequest",
3068
+ "definitions": {
3069
+ "GetIncomingRequestRequest": {
3070
+ "type": "object",
3071
+ "properties": {
3072
+ "id": {
3073
+ "type": "string",
3074
+ "pattern": "REQ[A-Za-z0-9]{17}"
3075
+ }
3076
+ },
3077
+ "required": [
3078
+ "id"
3079
+ ],
3080
+ "additionalProperties": false
3081
+ }
3082
+ }
3083
+ };
3084
+ exports.GetIncomingRequestsRequest = {
3085
+ "$schema": "http://json-schema.org/draft-07/schema#",
3086
+ "$ref": "#/definitions/GetIncomingRequestsRequest",
3087
+ "definitions": {
3088
+ "GetIncomingRequestsRequest": {
3089
+ "type": "object",
3090
+ "properties": {
3091
+ "query": {
3092
+ "$ref": "#/definitions/GetIncomingRequestsRequestQuery"
3093
+ }
3094
+ },
3095
+ "additionalProperties": false
3096
+ },
3097
+ "GetIncomingRequestsRequestQuery": {
3098
+ "type": "object",
3099
+ "properties": {
3100
+ "id": {
3101
+ "type": "string"
3102
+ },
3103
+ "peer": {
3104
+ "type": "string"
3105
+ },
3106
+ "createdAt": {
3107
+ "type": "string"
3108
+ },
3109
+ "status": {
3110
+ "type": "string"
3111
+ },
3112
+ "content": {
3113
+ "type": "object",
3114
+ "properties": {
3115
+ "expiresAt": {
3116
+ "type": "string"
3117
+ },
3118
+ "items": {
3119
+ "type": "object",
3120
+ "properties": {
3121
+ "@type": {
3122
+ "type": "string"
3123
+ }
3124
+ },
3125
+ "additionalProperties": false
3126
+ }
3127
+ },
3128
+ "additionalProperties": false
3129
+ },
3130
+ "source": {
3131
+ "type": "object",
3132
+ "properties": {
3133
+ "type": {
3134
+ "type": "string"
3135
+ },
3136
+ "reference": {
3137
+ "type": "string"
3138
+ }
3139
+ },
3140
+ "additionalProperties": false
3141
+ },
3142
+ "response": {
3143
+ "type": "object",
3144
+ "properties": {
3145
+ "createdAt": {
3146
+ "type": "string"
3147
+ },
3148
+ "source": {
3149
+ "type": "object",
3150
+ "properties": {
3151
+ "type": {
3152
+ "type": "string"
3153
+ },
3154
+ "reference": {
3155
+ "type": "string"
3156
+ }
3157
+ },
3158
+ "additionalProperties": false
3159
+ },
3160
+ "content": {
3161
+ "type": "object",
3162
+ "properties": {
3163
+ "result": {
3164
+ "type": "string"
3165
+ },
3166
+ "items": {
3167
+ "type": "object",
3168
+ "properties": {
3169
+ "@type": {
3170
+ "type": "string"
3171
+ },
3172
+ "items": {
3173
+ "type": "object",
3174
+ "properties": {
3175
+ "@type": {
3176
+ "type": "string"
3177
+ }
3178
+ },
3179
+ "additionalProperties": false
3180
+ }
3181
+ },
3182
+ "additionalProperties": false
3183
+ }
3184
+ },
3185
+ "additionalProperties": false
3186
+ }
3187
+ },
3188
+ "additionalProperties": false
3189
+ }
3190
+ },
3191
+ "additionalProperties": {}
3192
+ }
3193
+ }
3194
+ };
3195
+ exports.GetOutgoingRequestRequest = {
3196
+ "$schema": "http://json-schema.org/draft-07/schema#",
3197
+ "$ref": "#/definitions/GetOutgoingRequestRequest",
3198
+ "definitions": {
3199
+ "GetOutgoingRequestRequest": {
3200
+ "type": "object",
3201
+ "properties": {
3202
+ "id": {
3203
+ "type": "string",
3204
+ "pattern": "REQ[A-Za-z0-9]{17}"
3205
+ }
3206
+ },
3207
+ "required": [
3208
+ "id"
3209
+ ],
3210
+ "additionalProperties": false
3211
+ }
3212
+ }
3213
+ };
3214
+ exports.GetOutgoingRequestsRequest = {
3215
+ "$schema": "http://json-schema.org/draft-07/schema#",
3216
+ "$ref": "#/definitions/GetOutgoingRequestsRequest",
3217
+ "definitions": {
3218
+ "GetOutgoingRequestsRequest": {
3219
+ "type": "object",
3220
+ "properties": {
3221
+ "query": {
3222
+ "$ref": "#/definitions/GetOutgoingRequestsRequestQuery"
3223
+ }
3224
+ },
3225
+ "additionalProperties": false
3226
+ },
3227
+ "GetOutgoingRequestsRequestQuery": {
3228
+ "type": "object",
3229
+ "properties": {
3230
+ "id": {
3231
+ "type": "string"
3232
+ },
3233
+ "peer": {
3234
+ "type": "string"
3235
+ },
3236
+ "createdAt": {
3237
+ "type": "string"
3238
+ },
3239
+ "status": {
3240
+ "type": "string"
3241
+ },
3242
+ "content": {
3243
+ "type": "object",
3244
+ "properties": {
3245
+ "expiresAt": {
3246
+ "type": "string"
3247
+ },
3248
+ "items": {
3249
+ "type": "object",
3250
+ "properties": {
3251
+ "@type": {
3252
+ "type": "string"
3253
+ }
3254
+ },
3255
+ "additionalProperties": false
3256
+ }
3257
+ },
3258
+ "additionalProperties": false
3259
+ },
3260
+ "source": {
3261
+ "type": "object",
3262
+ "properties": {
3263
+ "type": {
3264
+ "type": "string"
3265
+ },
3266
+ "reference": {
3267
+ "type": "string"
3268
+ }
3269
+ },
3270
+ "additionalProperties": false
3271
+ },
3272
+ "response": {
3273
+ "type": "object",
3274
+ "properties": {
3275
+ "createdAt": {
3276
+ "type": "string"
3277
+ },
3278
+ "source": {
3279
+ "type": "object",
3280
+ "properties": {
3281
+ "type": {
3282
+ "type": "string"
3283
+ },
3284
+ "reference": {
3285
+ "type": "string"
3286
+ }
3287
+ },
3288
+ "additionalProperties": false
3289
+ },
3290
+ "content": {
3291
+ "type": "object",
3292
+ "properties": {
3293
+ "result": {
3294
+ "type": "string"
3295
+ },
3296
+ "items": {
3297
+ "type": "object",
3298
+ "properties": {
3299
+ "@type": {
3300
+ "type": "string"
3301
+ },
3302
+ "items": {
3303
+ "type": "object",
3304
+ "properties": {
3305
+ "@type": {
3306
+ "type": "string"
3307
+ }
3308
+ },
3309
+ "additionalProperties": false
3310
+ }
3311
+ },
3312
+ "additionalProperties": false
3313
+ }
3314
+ },
3315
+ "additionalProperties": false
3316
+ }
3317
+ },
3318
+ "additionalProperties": false
3319
+ }
3320
+ },
3321
+ "additionalProperties": {}
3322
+ }
3323
+ }
3324
+ };
3325
+ exports.ReceivedIncomingRequestRequest = {
1833
3326
  "$schema": "http://json-schema.org/draft-07/schema#",
1834
- "$ref": "#/definitions/GetIncomingRequestRequest",
3327
+ "$ref": "#/definitions/ReceivedIncomingRequestRequest",
1835
3328
  "definitions": {
1836
- "GetIncomingRequestRequest": {
3329
+ "ReceivedIncomingRequestRequest": {
3330
+ "type": "object",
3331
+ "properties": {
3332
+ "receivedRequest": {
3333
+ "$ref": "#/definitions/RequestJSON"
3334
+ },
3335
+ "requestSourceId": {
3336
+ "type": "string",
3337
+ "description": "The id of the Message or RelationshipTemplate in which the Response was received.",
3338
+ "pattern": "(MSG|RLT)[A-Za-z0-9]{17}"
3339
+ }
3340
+ },
3341
+ "required": [
3342
+ "receivedRequest",
3343
+ "requestSourceId"
3344
+ ],
3345
+ "additionalProperties": false
3346
+ },
3347
+ "RequestJSON": {
1837
3348
  "type": "object",
1838
3349
  "properties": {
3350
+ "@type": {
3351
+ "type": "string"
3352
+ },
3353
+ "@context": {
3354
+ "type": "string"
3355
+ },
3356
+ "@version": {
3357
+ "type": "string"
3358
+ },
1839
3359
  "id": {
3360
+ "type": "string"
3361
+ },
3362
+ "expiresAt": {
1840
3363
  "type": "string",
1841
- "pattern": "REQ[A-Za-z0-9]{17}"
3364
+ "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
3365
+ "default": "undefined - the request won't expire"
3366
+ },
3367
+ "items": {
3368
+ "type": "array",
3369
+ "items": {
3370
+ "anyOf": [
3371
+ {
3372
+ "$ref": "#/definitions/RequestItemGroupJSON"
3373
+ },
3374
+ {
3375
+ "$ref": "#/definitions/RequestItemJSONDerivations"
3376
+ }
3377
+ ]
3378
+ },
3379
+ "description": "The items of the Request. Can be either a single {@link RequestItemJSONDerivations RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSONDerivations RequestItems } ."
3380
+ },
3381
+ "metadata": {
3382
+ "type": "object",
3383
+ "description": "This property can be used to add some arbitrary metadata to this request. The content of this property will be copied into the response on the side of the recipient."
3384
+ }
3385
+ },
3386
+ "required": [
3387
+ "@type",
3388
+ "items"
3389
+ ],
3390
+ "additionalProperties": false
3391
+ },
3392
+ "RequestItemGroupJSON": {
3393
+ "type": "object",
3394
+ "properties": {
3395
+ "@type": {
3396
+ "type": "string"
3397
+ },
3398
+ "@context": {
3399
+ "type": "string"
3400
+ },
3401
+ "@version": {
3402
+ "type": "string"
3403
+ },
3404
+ "title": {
3405
+ "type": "string",
3406
+ "description": "The human-readable title of this group."
3407
+ },
3408
+ "description": {
3409
+ "type": "string",
3410
+ "description": "The human-readable description of this group."
3411
+ },
3412
+ "mustBeAccepted": {
3413
+ "type": "boolean",
3414
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
3415
+ },
3416
+ "metadata": {
3417
+ "type": "object",
3418
+ "description": "This property can be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3419
+ },
3420
+ "items": {
3421
+ "type": "array",
3422
+ "items": {
3423
+ "$ref": "#/definitions/RequestItemJSONDerivations"
3424
+ },
3425
+ "description": "The items of this group."
3426
+ }
3427
+ },
3428
+ "required": [
3429
+ "@type",
3430
+ "items",
3431
+ "mustBeAccepted"
3432
+ ],
3433
+ "additionalProperties": false,
3434
+ "description": "A RequestItemGroup can be used to group one or more RequestItems. This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
3435
+ },
3436
+ "RequestItemJSONDerivations": {
3437
+ "anyOf": [
3438
+ {
3439
+ "$ref": "#/definitions/RequestItemJSON"
3440
+ },
3441
+ {
3442
+ "$ref": "#/definitions/CreateAttributeRequestItemJSON"
3443
+ },
3444
+ {
3445
+ "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
3446
+ },
3447
+ {
3448
+ "$ref": "#/definitions/ReadAttributeRequestItemJSON"
3449
+ },
3450
+ {
3451
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
3452
+ }
3453
+ ]
3454
+ },
3455
+ "RequestItemJSON": {
3456
+ "type": "object",
3457
+ "properties": {
3458
+ "@type": {
3459
+ "type": "string"
3460
+ },
3461
+ "@context": {
3462
+ "type": "string"
3463
+ },
3464
+ "@version": {
3465
+ "type": "string"
3466
+ },
3467
+ "title": {
3468
+ "type": "string",
3469
+ "description": "The human-readable title of this item."
3470
+ },
3471
+ "description": {
3472
+ "type": "string",
3473
+ "description": "The human-readable description of this item."
3474
+ },
3475
+ "metadata": {
3476
+ "type": "object",
3477
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3478
+ },
3479
+ "mustBeAccepted": {
3480
+ "type": "boolean",
3481
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
3482
+ }
3483
+ },
3484
+ "required": [
3485
+ "@type",
3486
+ "mustBeAccepted"
3487
+ ],
3488
+ "additionalProperties": false
3489
+ },
3490
+ "CreateAttributeRequestItemJSON": {
3491
+ "type": "object",
3492
+ "properties": {
3493
+ "@type": {
3494
+ "type": "string"
3495
+ },
3496
+ "@context": {
3497
+ "type": "string"
3498
+ },
3499
+ "@version": {
3500
+ "type": "string"
3501
+ },
3502
+ "title": {
3503
+ "type": "string",
3504
+ "description": "The human-readable title of this item."
3505
+ },
3506
+ "description": {
3507
+ "type": "string",
3508
+ "description": "The human-readable description of this item."
3509
+ },
3510
+ "metadata": {
3511
+ "type": "object",
3512
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3513
+ },
3514
+ "mustBeAccepted": {
3515
+ "type": "boolean",
3516
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
3517
+ },
3518
+ "attribute": {
3519
+ "anyOf": [
3520
+ {
3521
+ "$ref": "#/definitions/IdentityAttributeJSON"
3522
+ },
3523
+ {
3524
+ "$ref": "#/definitions/RelationshipAttributeJSON"
3525
+ }
3526
+ ]
3527
+ },
3528
+ "sourceAttributeId": {
3529
+ "type": "string"
3530
+ }
3531
+ },
3532
+ "required": [
3533
+ "@type",
3534
+ "attribute",
3535
+ "mustBeAccepted"
3536
+ ],
3537
+ "additionalProperties": false
3538
+ },
3539
+ "IdentityAttributeJSON": {
3540
+ "type": "object",
3541
+ "properties": {
3542
+ "@type": {
3543
+ "type": "string"
3544
+ },
3545
+ "@context": {
3546
+ "type": "string"
3547
+ },
3548
+ "@version": {
3549
+ "type": "string"
3550
+ },
3551
+ "owner": {
3552
+ "type": "string"
3553
+ },
3554
+ "validFrom": {
3555
+ "type": "string"
3556
+ },
3557
+ "validTo": {
3558
+ "type": "string"
3559
+ },
3560
+ "value": {
3561
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
3562
+ },
3563
+ "tags": {
3564
+ "type": "array",
3565
+ "items": {
3566
+ "type": "string"
3567
+ }
1842
3568
  }
1843
3569
  },
1844
3570
  "required": [
1845
- "id"
3571
+ "@type",
3572
+ "owner",
3573
+ "value"
1846
3574
  ],
1847
3575
  "additionalProperties": false
1848
- }
1849
- }
1850
- };
1851
- exports.GetIncomingRequestsRequest = {
1852
- "$schema": "http://json-schema.org/draft-07/schema#",
1853
- "$ref": "#/definitions/GetIncomingRequestsRequest",
1854
- "definitions": {
1855
- "GetIncomingRequestsRequest": {
3576
+ },
3577
+ "AbstractAttributeValueJSON": {
1856
3578
  "type": "object",
1857
3579
  "properties": {
1858
- "query": {
1859
- "$ref": "#/definitions/GetIncomingRequestsRequestQuery"
3580
+ "@type": {
3581
+ "type": "string"
3582
+ },
3583
+ "@context": {
3584
+ "type": "string"
3585
+ },
3586
+ "@version": {
3587
+ "type": "string"
1860
3588
  }
1861
3589
  },
1862
- "additionalProperties": false
3590
+ "required": [
3591
+ "@type"
3592
+ ]
1863
3593
  },
1864
- "GetIncomingRequestsRequestQuery": {
3594
+ "RelationshipAttributeJSON": {
1865
3595
  "type": "object",
1866
3596
  "properties": {
1867
- "id": {
3597
+ "@type": {
1868
3598
  "type": "string"
1869
3599
  },
1870
- "peer": {
3600
+ "@context": {
1871
3601
  "type": "string"
1872
3602
  },
1873
- "createdAt": {
3603
+ "@version": {
1874
3604
  "type": "string"
1875
3605
  },
1876
- "status": {
3606
+ "owner": {
1877
3607
  "type": "string"
1878
3608
  },
1879
- "content": {
1880
- "type": "object",
1881
- "properties": {
1882
- "expiresAt": {
1883
- "type": "string"
1884
- },
1885
- "items": {
1886
- "type": "object",
1887
- "properties": {
1888
- "@type": {
1889
- "type": "string"
1890
- }
1891
- },
1892
- "additionalProperties": false
1893
- }
1894
- },
1895
- "additionalProperties": false
3609
+ "validFrom": {
3610
+ "type": "string"
1896
3611
  },
1897
- "source": {
3612
+ "validTo": {
3613
+ "type": "string"
3614
+ },
3615
+ "value": {
3616
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
3617
+ },
3618
+ "key": {
3619
+ "type": "string"
3620
+ },
3621
+ "isTechnical": {
3622
+ "type": "boolean"
3623
+ },
3624
+ "confidentiality": {
3625
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
3626
+ }
3627
+ },
3628
+ "required": [
3629
+ "@type",
3630
+ "confidentiality",
3631
+ "key",
3632
+ "owner",
3633
+ "value"
3634
+ ],
3635
+ "additionalProperties": false
3636
+ },
3637
+ "RelationshipAttributeConfidentiality": {
3638
+ "type": "string",
3639
+ "enum": [
3640
+ "public",
3641
+ "private",
3642
+ "protected"
3643
+ ]
3644
+ },
3645
+ "ProposeAttributeRequestItemJSON": {
3646
+ "type": "object",
3647
+ "properties": {
3648
+ "@type": {
3649
+ "type": "string"
3650
+ },
3651
+ "@context": {
3652
+ "type": "string"
3653
+ },
3654
+ "@version": {
3655
+ "type": "string"
3656
+ },
3657
+ "title": {
3658
+ "type": "string",
3659
+ "description": "The human-readable title of this item."
3660
+ },
3661
+ "description": {
3662
+ "type": "string",
3663
+ "description": "The human-readable description of this item."
3664
+ },
3665
+ "metadata": {
1898
3666
  "type": "object",
1899
- "properties": {
1900
- "type": {
1901
- "type": "string"
3667
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3668
+ },
3669
+ "mustBeAccepted": {
3670
+ "type": "boolean",
3671
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
3672
+ },
3673
+ "query": {
3674
+ "anyOf": [
3675
+ {
3676
+ "$ref": "#/definitions/IdentityAttributeQueryJSON"
1902
3677
  },
1903
- "reference": {
1904
- "type": "string"
3678
+ {
3679
+ "$ref": "#/definitions/RelationshipAttributeQueryJSON"
1905
3680
  }
1906
- },
1907
- "additionalProperties": false
3681
+ ]
1908
3682
  },
1909
- "response": {
1910
- "type": "object",
1911
- "properties": {
1912
- "createdAt": {
1913
- "type": "string"
1914
- },
1915
- "source": {
1916
- "type": "object",
1917
- "properties": {
1918
- "type": {
1919
- "type": "string"
1920
- },
1921
- "reference": {
1922
- "type": "string"
1923
- }
1924
- },
1925
- "additionalProperties": false
3683
+ "attribute": {
3684
+ "anyOf": [
3685
+ {
3686
+ "$ref": "#/definitions/IdentityAttributeJSON"
1926
3687
  },
1927
- "content": {
1928
- "type": "object",
1929
- "properties": {
1930
- "result": {
1931
- "type": "string"
1932
- },
1933
- "items": {
1934
- "type": "object",
1935
- "properties": {
1936
- "@type": {
1937
- "type": "string"
1938
- },
1939
- "items": {
1940
- "type": "object",
1941
- "properties": {
1942
- "@type": {
1943
- "type": "string"
1944
- }
1945
- },
1946
- "additionalProperties": false
1947
- }
1948
- },
1949
- "additionalProperties": false
1950
- }
1951
- },
1952
- "additionalProperties": false
3688
+ {
3689
+ "$ref": "#/definitions/RelationshipAttributeJSON"
1953
3690
  }
1954
- },
1955
- "additionalProperties": false
3691
+ ]
1956
3692
  }
1957
3693
  },
1958
- "additionalProperties": {}
1959
- }
1960
- }
1961
- };
1962
- exports.GetOutgoingRequestRequest = {
1963
- "$schema": "http://json-schema.org/draft-07/schema#",
1964
- "$ref": "#/definitions/GetOutgoingRequestRequest",
1965
- "definitions": {
1966
- "GetOutgoingRequestRequest": {
3694
+ "required": [
3695
+ "@type",
3696
+ "attribute",
3697
+ "mustBeAccepted",
3698
+ "query"
3699
+ ],
3700
+ "additionalProperties": false
3701
+ },
3702
+ "IdentityAttributeQueryJSON": {
1967
3703
  "type": "object",
1968
3704
  "properties": {
1969
- "id": {
1970
- "type": "string",
1971
- "pattern": "REQ[A-Za-z0-9]{17}"
3705
+ "@type": {
3706
+ "type": "string"
3707
+ },
3708
+ "@context": {
3709
+ "type": "string"
3710
+ },
3711
+ "@version": {
3712
+ "type": "string"
3713
+ },
3714
+ "valueType": {
3715
+ "type": "string"
3716
+ },
3717
+ "validFrom": {
3718
+ "type": "string"
3719
+ },
3720
+ "validTo": {
3721
+ "type": "string"
3722
+ },
3723
+ "tags": {
3724
+ "type": "array",
3725
+ "items": {
3726
+ "type": "string"
3727
+ }
3728
+ }
3729
+ },
3730
+ "additionalProperties": false,
3731
+ "required": [
3732
+ "@type",
3733
+ "valueType"
3734
+ ]
3735
+ },
3736
+ "RelationshipAttributeQueryJSON": {
3737
+ "type": "object",
3738
+ "properties": {
3739
+ "@type": {
3740
+ "type": "string"
3741
+ },
3742
+ "@context": {
3743
+ "type": "string"
3744
+ },
3745
+ "@version": {
3746
+ "type": "string"
3747
+ },
3748
+ "valueType": {
3749
+ "type": "string"
3750
+ },
3751
+ "validFrom": {
3752
+ "type": "string"
3753
+ },
3754
+ "validTo": {
3755
+ "type": "string"
3756
+ },
3757
+ "key": {
3758
+ "type": "string"
3759
+ },
3760
+ "owner": {
3761
+ "type": "string"
3762
+ },
3763
+ "thirdParty": {
3764
+ "type": "string"
3765
+ },
3766
+ "attributeCreationHints": {
3767
+ "$ref": "#/definitions/RelationshipAttributeCreationHintsJSON"
1972
3768
  }
1973
3769
  },
1974
3770
  "required": [
1975
- "id"
3771
+ "@type",
3772
+ "attributeCreationHints",
3773
+ "key",
3774
+ "owner",
3775
+ "valueType"
1976
3776
  ],
1977
3777
  "additionalProperties": false
1978
- }
1979
- }
1980
- };
1981
- exports.GetOutgoingRequestsRequest = {
1982
- "$schema": "http://json-schema.org/draft-07/schema#",
1983
- "$ref": "#/definitions/GetOutgoingRequestsRequest",
1984
- "definitions": {
1985
- "GetOutgoingRequestsRequest": {
3778
+ },
3779
+ "RelationshipAttributeCreationHintsJSON": {
1986
3780
  "type": "object",
1987
3781
  "properties": {
1988
- "query": {
1989
- "$ref": "#/definitions/GetOutgoingRequestsRequestQuery"
3782
+ "title": {
3783
+ "type": "string"
3784
+ },
3785
+ "description": {
3786
+ "type": "string"
3787
+ },
3788
+ "valueHints": {
3789
+ "$ref": "#/definitions/ValueHintsJSON"
3790
+ },
3791
+ "isTechnical": {
3792
+ "type": "boolean"
3793
+ },
3794
+ "confidentiality": {
3795
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
1990
3796
  }
1991
3797
  },
3798
+ "required": [
3799
+ "title",
3800
+ "confidentiality"
3801
+ ],
1992
3802
  "additionalProperties": false
1993
3803
  },
1994
- "GetOutgoingRequestsRequestQuery": {
3804
+ "ValueHintsJSON": {
1995
3805
  "type": "object",
1996
3806
  "properties": {
1997
- "id": {
3807
+ "@type": {
1998
3808
  "type": "string"
1999
3809
  },
2000
- "peer": {
3810
+ "@context": {
2001
3811
  "type": "string"
2002
3812
  },
2003
- "createdAt": {
3813
+ "@version": {
2004
3814
  "type": "string"
2005
3815
  },
2006
- "status": {
3816
+ "editHelp": {
2007
3817
  "type": "string"
2008
3818
  },
2009
- "content": {
2010
- "type": "object",
2011
- "properties": {
2012
- "expiresAt": {
2013
- "type": "string"
2014
- },
2015
- "items": {
2016
- "type": "object",
2017
- "properties": {
2018
- "@type": {
2019
- "type": "string"
2020
- }
2021
- },
2022
- "additionalProperties": false
2023
- }
2024
- },
2025
- "additionalProperties": false
3819
+ "min": {
3820
+ "type": "number"
2026
3821
  },
2027
- "source": {
2028
- "type": "object",
2029
- "properties": {
2030
- "type": {
2031
- "type": "string"
2032
- },
2033
- "reference": {
2034
- "type": "string"
2035
- }
2036
- },
2037
- "additionalProperties": false
3822
+ "max": {
3823
+ "type": "number"
2038
3824
  },
2039
- "response": {
3825
+ "pattern": {
3826
+ "type": "string"
3827
+ },
3828
+ "values": {
3829
+ "type": "array",
3830
+ "items": {
3831
+ "$ref": "#/definitions/ValueHintsValueJSON"
3832
+ }
3833
+ },
3834
+ "defaultValue": {
3835
+ "type": [
3836
+ "string",
3837
+ "number",
3838
+ "boolean"
3839
+ ]
3840
+ },
3841
+ "propertyHints": {
2040
3842
  "type": "object",
2041
- "properties": {
2042
- "createdAt": {
2043
- "type": "string"
2044
- },
2045
- "source": {
2046
- "type": "object",
2047
- "properties": {
2048
- "type": {
2049
- "type": "string"
2050
- },
2051
- "reference": {
2052
- "type": "string"
2053
- }
2054
- },
2055
- "additionalProperties": false
2056
- },
2057
- "content": {
2058
- "type": "object",
2059
- "properties": {
2060
- "result": {
2061
- "type": "string"
2062
- },
2063
- "items": {
2064
- "type": "object",
2065
- "properties": {
2066
- "@type": {
2067
- "type": "string"
2068
- },
2069
- "items": {
2070
- "type": "object",
2071
- "properties": {
2072
- "@type": {
2073
- "type": "string"
2074
- }
2075
- },
2076
- "additionalProperties": false
2077
- }
2078
- },
2079
- "additionalProperties": false
2080
- }
2081
- },
2082
- "additionalProperties": false
2083
- }
2084
- },
2085
- "additionalProperties": false
3843
+ "additionalProperties": {
3844
+ "$ref": "#/definitions/ValueHintsJSON"
3845
+ }
2086
3846
  }
2087
3847
  },
2088
- "additionalProperties": {}
2089
- }
2090
- }
2091
- };
2092
- exports.ReceivedIncomingRequestRequest = {
2093
- "$schema": "http://json-schema.org/draft-07/schema#",
2094
- "$ref": "#/definitions/ReceivedIncomingRequestRequest",
2095
- "definitions": {
2096
- "ReceivedIncomingRequestRequest": {
3848
+ "additionalProperties": false,
3849
+ "required": [
3850
+ "@type"
3851
+ ]
3852
+ },
3853
+ "ValueHintsValueJSON": {
2097
3854
  "type": "object",
2098
3855
  "properties": {
2099
- "receivedRequest": {
2100
- "$ref": "#/definitions/RequestJSON"
3856
+ "key": {
3857
+ "type": [
3858
+ "string",
3859
+ "number",
3860
+ "boolean"
3861
+ ]
2101
3862
  },
2102
- "requestSourceId": {
2103
- "type": "string",
2104
- "description": "The id of the Message or RelationshipTemplate in which the Response was received.",
2105
- "pattern": "(MSG|RLT)[A-Za-z0-9]{17}"
3863
+ "displayName": {
3864
+ "type": "string"
2106
3865
  }
2107
3866
  },
2108
3867
  "required": [
2109
- "receivedRequest",
2110
- "requestSourceId"
3868
+ "key",
3869
+ "displayName"
2111
3870
  ],
2112
3871
  "additionalProperties": false
2113
3872
  },
2114
- "RequestJSON": {
3873
+ "ReadAttributeRequestItemJSON": {
2115
3874
  "type": "object",
2116
3875
  "properties": {
2117
3876
  "@type": {
@@ -2123,40 +3882,34 @@ exports.ReceivedIncomingRequestRequest = {
2123
3882
  "@version": {
2124
3883
  "type": "string"
2125
3884
  },
2126
- "id": {
2127
- "type": "string"
2128
- },
2129
- "expiresAt": {
3885
+ "title": {
2130
3886
  "type": "string",
2131
- "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
2132
- "default": "undefined - the request won't expire"
3887
+ "description": "The human-readable title of this item."
2133
3888
  },
2134
- "items": {
2135
- "type": "array",
2136
- "items": {
2137
- "anyOf": [
2138
- {
2139
- "$ref": "#/definitions/RequestItemGroupJSON"
2140
- },
2141
- {
2142
- "$ref": "#/definitions/RequestItemJSON"
2143
- }
2144
- ]
2145
- },
2146
- "description": "The items of the Request. Can be either a single {@link RequestItemJSON RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSON RequestItems } ."
3889
+ "description": {
3890
+ "type": "string",
3891
+ "description": "The human-readable description of this item."
2147
3892
  },
2148
- "responseMetadata": {
3893
+ "metadata": {
2149
3894
  "type": "object",
2150
- "description": "This property can be used to add some arbitrary metadata to this request. The content of this property will be copied into the response on the side of the recipient."
3895
+ "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3896
+ },
3897
+ "mustBeAccepted": {
3898
+ "type": "boolean",
3899
+ "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
3900
+ },
3901
+ "query": {
3902
+ "$ref": "#/definitions/AbstractAttributeQueryJSON"
2151
3903
  }
2152
3904
  },
2153
3905
  "required": [
2154
3906
  "@type",
2155
- "items"
3907
+ "mustBeAccepted",
3908
+ "query"
2156
3909
  ],
2157
3910
  "additionalProperties": false
2158
3911
  },
2159
- "RequestItemGroupJSON": {
3912
+ "AbstractAttributeQueryJSON": {
2160
3913
  "type": "object",
2161
3914
  "properties": {
2162
3915
  "@type": {
@@ -2168,39 +3921,23 @@ exports.ReceivedIncomingRequestRequest = {
2168
3921
  "@version": {
2169
3922
  "type": "string"
2170
3923
  },
2171
- "title": {
2172
- "type": "string",
2173
- "description": "The human-readable title of this group."
2174
- },
2175
- "description": {
2176
- "type": "string",
2177
- "description": "The human-readable description of this group."
2178
- },
2179
- "mustBeAccepted": {
2180
- "type": "boolean",
2181
- "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
3924
+ "valueType": {
3925
+ "type": "string"
2182
3926
  },
2183
- "responseMetadata": {
2184
- "type": "object",
2185
- "description": "This property can be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
3927
+ "validFrom": {
3928
+ "type": "string"
2186
3929
  },
2187
- "items": {
2188
- "type": "array",
2189
- "items": {
2190
- "$ref": "#/definitions/RequestItemJSON"
2191
- },
2192
- "description": "The items of this group."
3930
+ "validTo": {
3931
+ "type": "string"
2193
3932
  }
2194
3933
  },
2195
3934
  "required": [
2196
3935
  "@type",
2197
- "items",
2198
- "mustBeAccepted"
3936
+ "valueType"
2199
3937
  ],
2200
- "additionalProperties": false,
2201
- "description": "A RequestItemGroup can be used to group one or more {@link RequestItemJSON RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single Request where the latter one targets an attribute created by the first one, it it should be impossible to reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
3938
+ "additionalProperties": false
2202
3939
  },
2203
- "RequestItemJSON": {
3940
+ "ShareAttributeRequestItemJSON": {
2204
3941
  "type": "object",
2205
3942
  "properties": {
2206
3943
  "@type": {
@@ -2220,18 +3957,26 @@ exports.ReceivedIncomingRequestRequest = {
2220
3957
  "type": "string",
2221
3958
  "description": "The human-readable description of this item."
2222
3959
  },
2223
- "responseMetadata": {
3960
+ "metadata": {
2224
3961
  "type": "object",
2225
3962
  "description": "This property can be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
2226
3963
  },
2227
3964
  "mustBeAccepted": {
2228
3965
  "type": "boolean",
2229
3966
  "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a {@link RequestItemJSON RequestItem } can only be accepted if the parent group is accepted as well."
3967
+ },
3968
+ "attributeId": {
3969
+ "type": "string"
3970
+ },
3971
+ "shareWith": {
3972
+ "type": "string"
2230
3973
  }
2231
3974
  },
2232
3975
  "required": [
2233
3976
  "@type",
2234
- "mustBeAccepted"
3977
+ "attributeId",
3978
+ "mustBeAccepted",
3979
+ "shareWith"
2235
3980
  ],
2236
3981
  "additionalProperties": false
2237
3982
  }