@open-resource-discovery/specification 1.14.1 → 1.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -106,6 +106,8 @@
|
|
|
106
106
|
"type": "boolean",
|
|
107
107
|
"description": "Whether the information in the ORD document is **system-instance-aware**.\nThis is the case when the provided ORD document potentially differs between **system instances** (e.g. due to multi-tenancy, configuration or extensibility).\n\nIf a document is system-instance-aware, an ORD aggregator MUST fetch it for _each_ **system instance** (tenant), not just once per system type.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nIt is strongly RECOMMENDED to split metadata into separate documents for the different perspectives (static vs. dynamic).\n\nFor a detailed explanation, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
108
108
|
"default": false,
|
|
109
|
+
"x-deprecated-in-version": "1.12.0",
|
|
110
|
+
"x-deprecation-text": "Please use `perspective` instead and split content of different perspectives into different ORD documents.",
|
|
109
111
|
"examples": [
|
|
110
112
|
true
|
|
111
113
|
]
|
|
@@ -114,6 +114,8 @@
|
|
|
114
114
|
],
|
|
115
115
|
"default": "none",
|
|
116
116
|
"x-introduced-in-version": "1.3.0",
|
|
117
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
118
|
+
"x-deprecated-in-version": "1.9.9",
|
|
117
119
|
"examples": [
|
|
118
120
|
"sap:core:v1"
|
|
119
121
|
]
|
|
@@ -124,6 +126,8 @@
|
|
|
124
126
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
125
127
|
"maxLength": 255,
|
|
126
128
|
"x-introduced-in-version": "1.3.0",
|
|
129
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
130
|
+
"x-deprecated-in-version": "1.9.9",
|
|
127
131
|
"examples": [
|
|
128
132
|
"sap.xref:customPolicy:v1"
|
|
129
133
|
]
|
|
@@ -336,6 +340,8 @@
|
|
|
336
340
|
],
|
|
337
341
|
"default": "none",
|
|
338
342
|
"x-introduced-in-version": "1.3.0",
|
|
343
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
344
|
+
"x-deprecated-in-version": "1.9.9",
|
|
339
345
|
"examples": [
|
|
340
346
|
"sap:core:v1"
|
|
341
347
|
]
|
|
@@ -346,6 +352,8 @@
|
|
|
346
352
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
347
353
|
"maxLength": 255,
|
|
348
354
|
"x-introduced-in-version": "1.3.0",
|
|
355
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
356
|
+
"x-deprecated-in-version": "1.9.9",
|
|
349
357
|
"examples": [
|
|
350
358
|
"sap.xref:customPolicy:v1"
|
|
351
359
|
]
|
|
@@ -377,6 +385,14 @@
|
|
|
377
385
|
"$ref": "#/definitions/Link"
|
|
378
386
|
}
|
|
379
387
|
},
|
|
388
|
+
"files": {
|
|
389
|
+
"type": "array",
|
|
390
|
+
"x-introduced-in-version": "1.14.2",
|
|
391
|
+
"description": "Generic list of files with arbitrary meaning and content. Meant to be used for linking PDFs, Word or similar content. This option MUST NOT be used for linking the actual metadata files like OpenAPI, AsyncAPI, CSN, etc.",
|
|
392
|
+
"items": {
|
|
393
|
+
"$ref": "#/definitions/File"
|
|
394
|
+
}
|
|
395
|
+
},
|
|
380
396
|
"licenseType": {
|
|
381
397
|
"type": "string",
|
|
382
398
|
"minLength": 1,
|
|
@@ -1025,9 +1041,14 @@
|
|
|
1025
1041
|
"type": "string",
|
|
1026
1042
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
1027
1043
|
"oneOf": [
|
|
1044
|
+
{
|
|
1045
|
+
"const": "development",
|
|
1046
|
+
"x-introduced-in-version": "1.14.2",
|
|
1047
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
1048
|
+
},
|
|
1028
1049
|
{
|
|
1029
1050
|
"const": "beta",
|
|
1030
|
-
"description": "The API contract has no stability guarantees
|
|
1051
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
1031
1052
|
},
|
|
1032
1053
|
{
|
|
1033
1054
|
"const": "active",
|
|
@@ -1335,6 +1356,8 @@
|
|
|
1335
1356
|
"entityTypeMappings": {
|
|
1336
1357
|
"type": "array",
|
|
1337
1358
|
"x-introduced-in-version": "1.6.0",
|
|
1359
|
+
"x-deprecated-in-version": "1.11.0",
|
|
1360
|
+
"x-deprecation-text": "Use the simplified `exposedEntityTypes` instead.",
|
|
1338
1361
|
"description": "Describes mappings between the API Models of the described resource to the underlying, conceptual entity types.",
|
|
1339
1362
|
"items": {
|
|
1340
1363
|
"$ref": "#/definitions/EntityTypeMapping"
|
|
@@ -1628,6 +1651,8 @@
|
|
|
1628
1651
|
],
|
|
1629
1652
|
"default": "none",
|
|
1630
1653
|
"x-introduced-in-version": "1.3.0",
|
|
1654
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
1655
|
+
"x-deprecated-in-version": "1.9.9",
|
|
1631
1656
|
"examples": [
|
|
1632
1657
|
"sap:core:v1"
|
|
1633
1658
|
]
|
|
@@ -1638,6 +1663,8 @@
|
|
|
1638
1663
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
1639
1664
|
"maxLength": 255,
|
|
1640
1665
|
"x-introduced-in-version": "1.3.0",
|
|
1666
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
1667
|
+
"x-deprecated-in-version": "1.9.9",
|
|
1641
1668
|
"examples": [
|
|
1642
1669
|
"sap.xref:customPolicy:v1"
|
|
1643
1670
|
]
|
|
@@ -1659,6 +1686,8 @@
|
|
|
1659
1686
|
"type": "boolean",
|
|
1660
1687
|
"description": "Defines whether this ORD resource is **system-instance-aware**.\nThis is the case when the referenced resource definitions are potentially different between **system instances**.\n\nIf this behavior applies, `systemInstanceAware` MUST be set to true.\nAn ORD aggregator MUST then fetch the referenced resource definitions for _each_ **system instance** individually.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nAll resources that are system-instance-aware should ideally be put into a dedicated ORD document with `perspective`: `system-instance`.\n\nFor more details, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
1661
1688
|
"default": false,
|
|
1689
|
+
"x-deprecated-in-version": "1.12.0",
|
|
1690
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
1662
1691
|
"examples": [
|
|
1663
1692
|
true
|
|
1664
1693
|
]
|
|
@@ -1857,9 +1886,14 @@
|
|
|
1857
1886
|
"type": "string",
|
|
1858
1887
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
1859
1888
|
"oneOf": [
|
|
1889
|
+
{
|
|
1890
|
+
"const": "development",
|
|
1891
|
+
"x-introduced-in-version": "1.14.2",
|
|
1892
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
1893
|
+
},
|
|
1860
1894
|
{
|
|
1861
1895
|
"const": "beta",
|
|
1862
|
-
"description": "The API contract has no stability guarantees
|
|
1896
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
1863
1897
|
},
|
|
1864
1898
|
{
|
|
1865
1899
|
"const": "active",
|
|
@@ -2012,6 +2046,8 @@
|
|
|
2012
2046
|
"entityTypeMappings": {
|
|
2013
2047
|
"type": "array",
|
|
2014
2048
|
"x-introduced-in-version": "1.6.0",
|
|
2049
|
+
"x-deprecated-in-version": "1.11.0",
|
|
2050
|
+
"x-deprecation-text": "Use the simplified `exposedEntityTypes` instead.",
|
|
2015
2051
|
"description": "Describes mappings between the API Models of the described resource to the underlying, conceptual entity types.",
|
|
2016
2052
|
"items": {
|
|
2017
2053
|
"$ref": "#/definitions/EntityTypeMapping"
|
|
@@ -2306,6 +2342,8 @@
|
|
|
2306
2342
|
],
|
|
2307
2343
|
"default": "none",
|
|
2308
2344
|
"x-introduced-in-version": "1.3.0",
|
|
2345
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2346
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2309
2347
|
"examples": [
|
|
2310
2348
|
"sap:core:v1"
|
|
2311
2349
|
]
|
|
@@ -2316,6 +2354,8 @@
|
|
|
2316
2354
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
2317
2355
|
"maxLength": 255,
|
|
2318
2356
|
"x-introduced-in-version": "1.3.0",
|
|
2357
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2358
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2319
2359
|
"examples": [
|
|
2320
2360
|
"sap.xref:customPolicy:v1"
|
|
2321
2361
|
]
|
|
@@ -2337,6 +2377,8 @@
|
|
|
2337
2377
|
"type": "boolean",
|
|
2338
2378
|
"description": "Defines whether this ORD resource is **system-instance-aware**.\nThis is the case when the referenced resource definitions are potentially different between **system instances**.\n\nIf this behavior applies, `systemInstanceAware` MUST be set to true.\nAn ORD aggregator MUST then fetch the referenced resource definitions for _each_ **system instance** individually.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nAll resources that are system-instance-aware should ideally be put into a dedicated ORD document with `perspective`: `system-instance`.\n\nFor more details, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
2339
2379
|
"default": false,
|
|
2380
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2381
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2340
2382
|
"examples": [
|
|
2341
2383
|
true
|
|
2342
2384
|
]
|
|
@@ -2519,9 +2561,14 @@
|
|
|
2519
2561
|
"type": "string",
|
|
2520
2562
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
2521
2563
|
"oneOf": [
|
|
2564
|
+
{
|
|
2565
|
+
"const": "development",
|
|
2566
|
+
"x-introduced-in-version": "1.14.2",
|
|
2567
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
2568
|
+
},
|
|
2522
2569
|
{
|
|
2523
2570
|
"const": "beta",
|
|
2524
|
-
"description": "The API contract has no stability guarantees
|
|
2571
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
2525
2572
|
},
|
|
2526
2573
|
{
|
|
2527
2574
|
"const": "active",
|
|
@@ -2673,6 +2720,8 @@
|
|
|
2673
2720
|
],
|
|
2674
2721
|
"default": "none",
|
|
2675
2722
|
"x-introduced-in-version": "1.3.0",
|
|
2723
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2724
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2676
2725
|
"examples": [
|
|
2677
2726
|
"sap:core:v1"
|
|
2678
2727
|
]
|
|
@@ -2683,6 +2732,8 @@
|
|
|
2683
2732
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
2684
2733
|
"maxLength": 255,
|
|
2685
2734
|
"x-introduced-in-version": "1.3.0",
|
|
2735
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2736
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2686
2737
|
"examples": [
|
|
2687
2738
|
"sap.xref:customPolicy:v1"
|
|
2688
2739
|
]
|
|
@@ -2704,6 +2755,8 @@
|
|
|
2704
2755
|
"type": "boolean",
|
|
2705
2756
|
"description": "Defines whether this ORD resource is **system-instance-aware**.\nThis is the case when the referenced resource definitions are potentially different between **system instances**.\n\nIf this behavior applies, `systemInstanceAware` MUST be set to true.\nAn ORD aggregator MUST then fetch the referenced resource definitions for _each_ **system instance** individually.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nAll resources that are system-instance-aware should ideally be put into a dedicated ORD document with `perspective`: `system-instance`.\n\nFor more details, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
2706
2757
|
"default": false,
|
|
2758
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2759
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2707
2760
|
"examples": [
|
|
2708
2761
|
true
|
|
2709
2762
|
]
|
|
@@ -2872,9 +2925,14 @@
|
|
|
2872
2925
|
"type": "string",
|
|
2873
2926
|
"description": "The `releaseStatus` specifies the stability towards incompatible changes in the future.\nIn the context of data products, it it covers only properties on the data product level.\nAPIs that are part of the input and output ports have their own independent `releaseStatus` and `version`.",
|
|
2874
2927
|
"oneOf": [
|
|
2928
|
+
{
|
|
2929
|
+
"const": "development",
|
|
2930
|
+
"x-introduced-in-version": "1.14.2",
|
|
2931
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
2932
|
+
},
|
|
2875
2933
|
{
|
|
2876
2934
|
"const": "beta",
|
|
2877
|
-
"description": "The API contract has no stability guarantees
|
|
2935
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
2878
2936
|
},
|
|
2879
2937
|
{
|
|
2880
2938
|
"const": "active",
|
|
@@ -3384,6 +3442,8 @@
|
|
|
3384
3442
|
],
|
|
3385
3443
|
"default": "none",
|
|
3386
3444
|
"x-introduced-in-version": "1.3.0",
|
|
3445
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
3446
|
+
"x-deprecated-in-version": "1.9.9",
|
|
3387
3447
|
"examples": [
|
|
3388
3448
|
"sap:core:v1"
|
|
3389
3449
|
]
|
|
@@ -3395,6 +3455,8 @@
|
|
|
3395
3455
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3396
3456
|
"maxLength": 255,
|
|
3397
3457
|
"x-introduced-in-version": "1.3.0",
|
|
3458
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
3459
|
+
"x-deprecated-in-version": "1.9.9",
|
|
3398
3460
|
"examples": [
|
|
3399
3461
|
"sap.xref:customPolicy:v1"
|
|
3400
3462
|
]
|
|
@@ -3417,6 +3479,8 @@
|
|
|
3417
3479
|
"type": "boolean",
|
|
3418
3480
|
"description": "Defines whether this ORD resource is **system-instance-aware**.\nThis is the case when the referenced resource definitions are potentially different between **system instances**.\n\nIf this behavior applies, `systemInstanceAware` MUST be set to true.\nAn ORD aggregator MUST then fetch the referenced resource definitions for _each_ **system instance** individually.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nAll resources that are system-instance-aware should ideally be put into a dedicated ORD document with `perspective`: `system-instance`.\n\nFor more details, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
3419
3481
|
"default": false,
|
|
3482
|
+
"x-deprecated-in-version": "1.12.0",
|
|
3483
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
3420
3484
|
"examples": [
|
|
3421
3485
|
true
|
|
3422
3486
|
]
|
|
@@ -3801,10 +3865,7 @@
|
|
|
3801
3865
|
"description": {
|
|
3802
3866
|
"type": "string",
|
|
3803
3867
|
"minLength": 1,
|
|
3804
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
3805
|
-
"examples": [
|
|
3806
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
3807
|
-
]
|
|
3868
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
3808
3869
|
},
|
|
3809
3870
|
"partOfPackage": {
|
|
3810
3871
|
"type": "string",
|
|
@@ -3869,9 +3930,14 @@
|
|
|
3869
3930
|
"type": "string",
|
|
3870
3931
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
3871
3932
|
"oneOf": [
|
|
3933
|
+
{
|
|
3934
|
+
"const": "development",
|
|
3935
|
+
"x-introduced-in-version": "1.14.2",
|
|
3936
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
3937
|
+
},
|
|
3872
3938
|
{
|
|
3873
3939
|
"const": "beta",
|
|
3874
|
-
"description": "The API contract has no stability guarantees
|
|
3940
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
3875
3941
|
},
|
|
3876
3942
|
{
|
|
3877
3943
|
"const": "active",
|
|
@@ -4477,10 +4543,7 @@
|
|
|
4477
4543
|
"description": {
|
|
4478
4544
|
"type": "string",
|
|
4479
4545
|
"minLength": 1,
|
|
4480
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
4481
|
-
"examples": [
|
|
4482
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
4483
|
-
]
|
|
4546
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
4484
4547
|
},
|
|
4485
4548
|
"partOfPackage": {
|
|
4486
4549
|
"type": "string",
|
|
@@ -4545,9 +4608,14 @@
|
|
|
4545
4608
|
"type": "string",
|
|
4546
4609
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
4547
4610
|
"oneOf": [
|
|
4611
|
+
{
|
|
4612
|
+
"const": "development",
|
|
4613
|
+
"x-introduced-in-version": "1.14.2",
|
|
4614
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
4615
|
+
},
|
|
4548
4616
|
{
|
|
4549
4617
|
"const": "beta",
|
|
4550
|
-
"description": "The API contract has no stability guarantees
|
|
4618
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
4551
4619
|
},
|
|
4552
4620
|
{
|
|
4553
4621
|
"const": "active",
|
|
@@ -4597,6 +4665,54 @@
|
|
|
4597
4665
|
]
|
|
4598
4666
|
]
|
|
4599
4667
|
},
|
|
4668
|
+
"relatedApiResources": {
|
|
4669
|
+
"type": "array",
|
|
4670
|
+
"x-introduced-in-version": "1.14.2",
|
|
4671
|
+
"description": "Optional list of related API Resources.\n\nUse this to indicate which APIs implement, expose, or are otherwise related to this capability.",
|
|
4672
|
+
"items": {
|
|
4673
|
+
"$ref": "#/definitions/RelatedApiResource"
|
|
4674
|
+
},
|
|
4675
|
+
"examples": [
|
|
4676
|
+
[
|
|
4677
|
+
{
|
|
4678
|
+
"ordId": "sap.s4:apiResource:API_BUSINESS_PARTNER:v1",
|
|
4679
|
+
"relationType": "foo.bar:relationName"
|
|
4680
|
+
}
|
|
4681
|
+
]
|
|
4682
|
+
]
|
|
4683
|
+
},
|
|
4684
|
+
"relatedEventResources": {
|
|
4685
|
+
"type": "array",
|
|
4686
|
+
"x-introduced-in-version": "1.14.2",
|
|
4687
|
+
"description": "Optional list of related Event Resources.\n\nUse this to indicate which events are emitted, consumed, or otherwise related to this capability.",
|
|
4688
|
+
"items": {
|
|
4689
|
+
"$ref": "#/definitions/RelatedEventResource"
|
|
4690
|
+
},
|
|
4691
|
+
"examples": [
|
|
4692
|
+
[
|
|
4693
|
+
{
|
|
4694
|
+
"ordId": "sap.s4:eventResource:BusinessPartnerEvents:v1",
|
|
4695
|
+
"relationType": "foo.bar:relationName"
|
|
4696
|
+
}
|
|
4697
|
+
]
|
|
4698
|
+
]
|
|
4699
|
+
},
|
|
4700
|
+
"relatedCapabilities": {
|
|
4701
|
+
"type": "array",
|
|
4702
|
+
"x-introduced-in-version": "1.14.2",
|
|
4703
|
+
"description": "Optional list of related Capabilities.\n\nUse this to indicate dependencies, extensions, or other relationships between capabilities.",
|
|
4704
|
+
"items": {
|
|
4705
|
+
"$ref": "#/definitions/RelatedCapability"
|
|
4706
|
+
},
|
|
4707
|
+
"examples": [
|
|
4708
|
+
[
|
|
4709
|
+
{
|
|
4710
|
+
"ordId": "sap.foo:capability:baseExtensibility:v1",
|
|
4711
|
+
"relationType": "foo.bar:relationName"
|
|
4712
|
+
}
|
|
4713
|
+
]
|
|
4714
|
+
]
|
|
4715
|
+
},
|
|
4600
4716
|
"definitions": {
|
|
4601
4717
|
"type": "array",
|
|
4602
4718
|
"description": "List of available machine-readable definitions, which describe the resource or capability in detail.\nSee also [Resource Definitions](../index.md#resource-definitions) for more context.\n\nEach definition is to be understood as an alternative description format, describing the same resource / capability.\nAs a consequence the same definition type MUST NOT be provided more than once.\nThe exception is when the same definition type is provided more than once, but with a different `visibility`.\n\nIt is RECOMMENDED to provide the definitions as they enable machine-readable use cases.\nIf the definitions are added or changed, the `version` MUST be incremented.\nAn ORD aggregator MAY only (re)fetch the definitions again when the `version` was incremented.",
|
|
@@ -4636,6 +4752,8 @@
|
|
|
4636
4752
|
"type": "boolean",
|
|
4637
4753
|
"description": "Defines whether this ORD resource is **system-instance-aware**.\nThis is the case when the referenced resource definitions are potentially different between **system instances**.\n\nIf this behavior applies, `systemInstanceAware` MUST be set to true.\nAn ORD aggregator MUST then fetch the referenced resource definitions for _each_ **system instance** individually.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nAll resources that are system-instance-aware should ideally be put into a dedicated ORD document with `perspective`: `system-instance`.\n\nFor more details, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
|
|
4638
4754
|
"default": false,
|
|
4755
|
+
"x-deprecated-in-version": "1.12.0",
|
|
4756
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
4639
4757
|
"examples": [
|
|
4640
4758
|
true
|
|
4641
4759
|
]
|
|
@@ -4813,10 +4931,7 @@
|
|
|
4813
4931
|
"description": {
|
|
4814
4932
|
"type": "string",
|
|
4815
4933
|
"minLength": 1,
|
|
4816
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
4817
|
-
"examples": [
|
|
4818
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
4819
|
-
]
|
|
4934
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
4820
4935
|
},
|
|
4821
4936
|
"partOfPackage": {
|
|
4822
4937
|
"type": "string",
|
|
@@ -4881,9 +4996,14 @@
|
|
|
4881
4996
|
"type": "string",
|
|
4882
4997
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
4883
4998
|
"oneOf": [
|
|
4999
|
+
{
|
|
5000
|
+
"const": "development",
|
|
5001
|
+
"x-introduced-in-version": "1.14.2",
|
|
5002
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
5003
|
+
},
|
|
4884
5004
|
{
|
|
4885
5005
|
"const": "beta",
|
|
4886
|
-
"description": "The API contract has no stability guarantees
|
|
5006
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
4887
5007
|
},
|
|
4888
5008
|
{
|
|
4889
5009
|
"const": "active",
|
|
@@ -5013,10 +5133,7 @@
|
|
|
5013
5133
|
"description": {
|
|
5014
5134
|
"type": "string",
|
|
5015
5135
|
"minLength": 1,
|
|
5016
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
5017
|
-
"examples": [
|
|
5018
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
5019
|
-
]
|
|
5136
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
5020
5137
|
},
|
|
5021
5138
|
"mandatory": {
|
|
5022
5139
|
"type": "boolean",
|
|
@@ -5039,6 +5156,13 @@
|
|
|
5039
5156
|
"items": {
|
|
5040
5157
|
"$ref": "#/definitions/EventResourceIntegrationAspect"
|
|
5041
5158
|
}
|
|
5159
|
+
},
|
|
5160
|
+
"capabilities": {
|
|
5161
|
+
"type": "array",
|
|
5162
|
+
"description": "List of Capability Dependencies.",
|
|
5163
|
+
"items": {
|
|
5164
|
+
"$ref": "#/definitions/CapabilityIntegrationAspect"
|
|
5165
|
+
}
|
|
5042
5166
|
}
|
|
5043
5167
|
},
|
|
5044
5168
|
"additionalProperties": false,
|
|
@@ -5179,6 +5303,37 @@
|
|
|
5179
5303
|
"operationId"
|
|
5180
5304
|
]
|
|
5181
5305
|
},
|
|
5306
|
+
"CapabilityIntegrationAspect": {
|
|
5307
|
+
"type": "object",
|
|
5308
|
+
"title": "Capability Integration Aspect",
|
|
5309
|
+
"x-introduced-in-version": "1.14.2",
|
|
5310
|
+
"x-ums-type": "custom",
|
|
5311
|
+
"description": "Capability related integration aspect",
|
|
5312
|
+
"properties": {
|
|
5313
|
+
"ordId": {
|
|
5314
|
+
"type": "string",
|
|
5315
|
+
"description": "The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.\n\nIt MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.",
|
|
5316
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(capability):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
5317
|
+
"maxLength": 255,
|
|
5318
|
+
"examples": [
|
|
5319
|
+
"sap.foo.bar:capability:fieldExtensibility:v1"
|
|
5320
|
+
]
|
|
5321
|
+
},
|
|
5322
|
+
"minVersion": {
|
|
5323
|
+
"type": "string",
|
|
5324
|
+
"description": "Minimum version of the references resource that the integration requires.\n",
|
|
5325
|
+
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
|
|
5326
|
+
"examples": [
|
|
5327
|
+
"1.2.3",
|
|
5328
|
+
"1.0.0-alpha.1"
|
|
5329
|
+
]
|
|
5330
|
+
}
|
|
5331
|
+
},
|
|
5332
|
+
"additionalProperties": false,
|
|
5333
|
+
"required": [
|
|
5334
|
+
"ordId"
|
|
5335
|
+
]
|
|
5336
|
+
},
|
|
5182
5337
|
"Vendor": {
|
|
5183
5338
|
"type": "object",
|
|
5184
5339
|
"title": "Vendor",
|
|
@@ -5267,9 +5422,14 @@
|
|
|
5267
5422
|
"type": "string",
|
|
5268
5423
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
5269
5424
|
"oneOf": [
|
|
5425
|
+
{
|
|
5426
|
+
"const": "development",
|
|
5427
|
+
"x-introduced-in-version": "1.14.2",
|
|
5428
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
5429
|
+
},
|
|
5270
5430
|
{
|
|
5271
5431
|
"const": "beta",
|
|
5272
|
-
"description": "The API contract has no stability guarantees
|
|
5432
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
5273
5433
|
},
|
|
5274
5434
|
{
|
|
5275
5435
|
"const": "active",
|
|
@@ -5342,7 +5502,7 @@
|
|
|
5342
5502
|
"description": {
|
|
5343
5503
|
"type": "string",
|
|
5344
5504
|
"minLength": 1,
|
|
5345
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown)",
|
|
5505
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).",
|
|
5346
5506
|
"examples": [
|
|
5347
5507
|
"This gives you an overview on where to find which kind of APIs in SAP S/4HANA.\n"
|
|
5348
5508
|
]
|
|
@@ -5360,6 +5520,62 @@
|
|
|
5360
5520
|
}
|
|
5361
5521
|
]
|
|
5362
5522
|
},
|
|
5523
|
+
"File": {
|
|
5524
|
+
"type": "object",
|
|
5525
|
+
"title": "File",
|
|
5526
|
+
"x-introduced-in-version": "1.14.2",
|
|
5527
|
+
"description": "File that can be attached on ORD package level.\n",
|
|
5528
|
+
"x-ums-type": "custom",
|
|
5529
|
+
"properties": {
|
|
5530
|
+
"title": {
|
|
5531
|
+
"type": "string",
|
|
5532
|
+
"minLength": 1,
|
|
5533
|
+
"description": "Human readable title of the file.\n\nMUST be unique within the collection of files provided.",
|
|
5534
|
+
"examples": [
|
|
5535
|
+
"Developer Guide for SAP Ariba Portal"
|
|
5536
|
+
]
|
|
5537
|
+
},
|
|
5538
|
+
"url": {
|
|
5539
|
+
"type": "string",
|
|
5540
|
+
"format": "uri-reference",
|
|
5541
|
+
"description": "[URL](https://tools.ietf.org/html/rfc3986) of the link.\n\nThe file target MAY be relative or absolute.\nIf a relative URL is given, it is relative to the [`describedSystemInstance.baseUrl`](#system-instance_baseurl).\nIf an absolute URL is given, then it MUST be openly accessible.",
|
|
5542
|
+
"examples": [
|
|
5543
|
+
"/ord/v1/Ariba/Files/DeveloperPortal/SAP-Ariba-developer-portal.pdf"
|
|
5544
|
+
]
|
|
5545
|
+
},
|
|
5546
|
+
"description": {
|
|
5547
|
+
"type": "string",
|
|
5548
|
+
"minLength": 1,
|
|
5549
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links.",
|
|
5550
|
+
"examples": [
|
|
5551
|
+
"Includes administrator, quick start, and authentication guides.\n"
|
|
5552
|
+
]
|
|
5553
|
+
},
|
|
5554
|
+
"mediaType": {
|
|
5555
|
+
"description": "The [Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the definition serialization format.\nA consuming application can use this information to know which file format parser it needs to use.\n\nIf no Media Type is registered for the referenced file, `text/plain` MAY be used for arbitrary plain-text and `application/octet-stream` for arbitrary binary data.\n",
|
|
5556
|
+
"type": "string",
|
|
5557
|
+
"pattern": "^(application|text)\\/[a-zA-Z0-9][a-zA-Z0-9.+\\-]*$",
|
|
5558
|
+
"examples": [
|
|
5559
|
+
"application/json",
|
|
5560
|
+
"text/plain",
|
|
5561
|
+
"application/xml"
|
|
5562
|
+
]
|
|
5563
|
+
}
|
|
5564
|
+
},
|
|
5565
|
+
"required": [
|
|
5566
|
+
"title",
|
|
5567
|
+
"url",
|
|
5568
|
+
"mediaType"
|
|
5569
|
+
],
|
|
5570
|
+
"examples": [
|
|
5571
|
+
{
|
|
5572
|
+
"url": "/ord/v1/Ariba/Files/DeveloperPortal/SAP-Ariba-developer-portal.pdf",
|
|
5573
|
+
"title": "Developer Guide for SAP Ariba Portal",
|
|
5574
|
+
"description": "Includes administrator, quick start, and authentication guides.",
|
|
5575
|
+
"mediaType": "application/pdf"
|
|
5576
|
+
}
|
|
5577
|
+
]
|
|
5578
|
+
},
|
|
5363
5579
|
"PackageLink": {
|
|
5364
5580
|
"type": "object",
|
|
5365
5581
|
"title": "Package Link",
|
|
@@ -5937,10 +6153,7 @@
|
|
|
5937
6153
|
"description": {
|
|
5938
6154
|
"type": "string",
|
|
5939
6155
|
"minLength": 1,
|
|
5940
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
5941
|
-
"examples": [
|
|
5942
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
5943
|
-
]
|
|
6156
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
5944
6157
|
},
|
|
5945
6158
|
"labels": {
|
|
5946
6159
|
"$ref": "#/definitions/Labels"
|
|
@@ -6022,10 +6235,7 @@
|
|
|
6022
6235
|
"description": {
|
|
6023
6236
|
"type": "string",
|
|
6024
6237
|
"minLength": 1,
|
|
6025
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
6026
|
-
"examples": [
|
|
6027
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
6028
|
-
]
|
|
6238
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description SHOULD not be excessive in length and is not meant to provide full documentation.\nDetailed documentation SHOULD be attached as (typed) links."
|
|
6029
6239
|
},
|
|
6030
6240
|
"labels": {
|
|
6031
6241
|
"$ref": "#/definitions/Labels"
|
|
@@ -6133,6 +6343,8 @@
|
|
|
6133
6343
|
"title": "Entity Type Mapping",
|
|
6134
6344
|
"type": "object",
|
|
6135
6345
|
"x-introduced-in-version": "1.6.0",
|
|
6346
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6347
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6136
6348
|
"x-ums-type": "custom",
|
|
6137
6349
|
"description": "An API or Event resource may optionally define its `entityTypeMappings`.\nThis is used to map and correlate the API models to the underlying, conceptual **entity types**.\n\nIf the mapping from API resource to entity types is not defined,\ncertain use-cases that rely on this explicit connection will not be possible.\n\nThis mapping is meant to be rather fine granular.\nTherefore, the mapping needs to be done on basis of one of the referenced resource definitions,\nas only there we know the details and the actual contents of the API Model of the API resource.\n\nFor the various resource definition formats the selection of API models may need to be expressed differently.\nAs a consequence, there are different types of selectors that are specialized toward certain resource definition formats.\n\nThe target of the mapping is a correlation to an entity type via a [Correlation ID](../index.md#correlation-id)\nor to an [ORD ID](../index.md#ord-id) of an entity type.\nIt is assumed that the entity types are described in more detail or on a different abstraction level via metadata.\nWhen the correlation ID is used, an ORD consumer may need to know how to access the entity type metadata through conventions.\nThis can be determined either by the namespace of the correlation ID,\nor through a defined and known `implementationStandard` that can resolve the `localId` fragment of the correlation ID .\n\nAt SAP, the metadata about entity types could be retrieved via the CSN_EXPOSURE service.\nTo indicate this, the service needs to be implemented and described in ORD with `implementationStandard` set to `sap:csn-exposure:v1`).\n\nODM 2.0 relies on the entity type mappings and uses the the mapping to express the relationship of an API to the\ncorresponding ODM entity. ORD consumers like SAP Business Accelerator Hub consume the mapping to make the relationships navigate-able for customers.",
|
|
6138
6350
|
"properties": {
|
|
@@ -6238,6 +6450,8 @@
|
|
|
6238
6450
|
"ApiModelSelectorOData": {
|
|
6239
6451
|
"title": "Api Model Selector (Odata)",
|
|
6240
6452
|
"x-introduced-in-version": "1.6.0",
|
|
6453
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6454
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.\n\nFor creating a mapping from API model to Entity Types, consider using the [Entity Relationship](https://sap.github.io/csn-interop-specification/annotations/entity-relationship) annotations.",
|
|
6241
6455
|
"x-ums-type": "custom",
|
|
6242
6456
|
"type": "object",
|
|
6243
6457
|
"description": "API Model Selector for OData, using entity set names for the selection.\n\nMUST only be used if the API Resource provides an API Resource Definition of type `edmx`.",
|
|
@@ -6273,6 +6487,8 @@
|
|
|
6273
6487
|
"ApiModelSelectorJsonPointer": {
|
|
6274
6488
|
"title": "Api Model Selector (Json Pointer)",
|
|
6275
6489
|
"x-introduced-in-version": "1.6.0",
|
|
6490
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6491
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.\n\nFor creating a mapping from API model to Entity Types, consider using the [Entity Relationship](https://sap.github.io/csn-interop-specification/annotations/entity-relationship) annotations.",
|
|
6276
6492
|
"x-ums-type": "custom",
|
|
6277
6493
|
"type": "object",
|
|
6278
6494
|
"description": "Generic API Model Selector for JSON / YAML based resource definitions.\nIt uses a [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) that points to the\nentity type description within the resource definition.\n\nThe JSON Pointer always to refer to the structure of the document as originally provided, before further post-processing like resolving $ref properties.\n\nMUST only be used if the API Resource provides an API Resource Definition of media type `application/json` or `text/yaml`.",
|
|
@@ -6335,6 +6551,8 @@
|
|
|
6335
6551
|
"EntityTypeOrdIdTarget": {
|
|
6336
6552
|
"title": "Entity Type Target (ORD ID)",
|
|
6337
6553
|
"x-introduced-in-version": "1.6.0",
|
|
6554
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6555
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6338
6556
|
"x-ums-type": "custom",
|
|
6339
6557
|
"type": "object",
|
|
6340
6558
|
"description": "Define which entity type is the target of an entity type mapping\n\nEntity types can be referenced using a [ORD ID](../index.md#ord-id) of an entity type.",
|
|
@@ -6362,6 +6580,8 @@
|
|
|
6362
6580
|
"type": "object",
|
|
6363
6581
|
"description": "Define which entity type is the target of an entity type mapping\n\nEntity types can be referenced using a [Correlation ID](../index.md#correlation-id).",
|
|
6364
6582
|
"x-introduced-in-version": "1.6.0",
|
|
6583
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6584
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6365
6585
|
"x-ums-type": "custom",
|
|
6366
6586
|
"properties": {
|
|
6367
6587
|
"correlationId": {
|
|
@@ -6399,10 +6619,15 @@
|
|
|
6399
6619
|
},
|
|
6400
6620
|
"relationType": {
|
|
6401
6621
|
"type": "string",
|
|
6402
|
-
"description": "Optional type of the relationship, which defines a stricter semantic what the relationship implies.\n\nIf not provided, the relationship type has no semantics, it's \"related somehow\".",
|
|
6622
|
+
"description": "Optional type of the relationship, which defines a stricter semantic what the relationship implies.\n\nIf not provided, the relationship type has no semantics, it's \"related somehow\".\n\nMUST be a valid [Concept ID](../index.md#concept-id).",
|
|
6403
6623
|
"x-introduced-in-version": "1.12.0",
|
|
6404
6624
|
"x-feature-status": "beta",
|
|
6405
|
-
"
|
|
6625
|
+
"anyOf": [
|
|
6626
|
+
{
|
|
6627
|
+
"type": "string",
|
|
6628
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6629
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6630
|
+
},
|
|
6406
6631
|
{
|
|
6407
6632
|
"const": "part-of",
|
|
6408
6633
|
"description": "The described entity type is a composite part of the referenced entity type.\nE.g. a `SalesOrderItem` is part of a `SalesOrder`."
|
|
@@ -6413,7 +6638,125 @@
|
|
|
6413
6638
|
}
|
|
6414
6639
|
],
|
|
6415
6640
|
"examples": [
|
|
6416
|
-
"can-share-identity"
|
|
6641
|
+
"can-share-identity",
|
|
6642
|
+
"foo.bar:relationName"
|
|
6643
|
+
]
|
|
6644
|
+
}
|
|
6645
|
+
},
|
|
6646
|
+
"required": [
|
|
6647
|
+
"ordId"
|
|
6648
|
+
],
|
|
6649
|
+
"additionalProperties": false
|
|
6650
|
+
},
|
|
6651
|
+
"RelatedApiResource": {
|
|
6652
|
+
"title": "Related API Resource",
|
|
6653
|
+
"x-introduced-in-version": "1.14.2",
|
|
6654
|
+
"x-ums-type": "embedded",
|
|
6655
|
+
"type": "object",
|
|
6656
|
+
"description": "Defines a relation to an API Resource (via its ORD ID).",
|
|
6657
|
+
"properties": {
|
|
6658
|
+
"ordId": {
|
|
6659
|
+
"type": "string",
|
|
6660
|
+
"description": "The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.\n\nIt MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.",
|
|
6661
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6662
|
+
"maxLength": 255,
|
|
6663
|
+
"examples": [
|
|
6664
|
+
"sap.s4:apiResource:API_BUSINESS_PARTNER:v1"
|
|
6665
|
+
],
|
|
6666
|
+
"x-association-target": [
|
|
6667
|
+
"#/definitions/ApiResource/ordId"
|
|
6668
|
+
]
|
|
6669
|
+
},
|
|
6670
|
+
"relationType": {
|
|
6671
|
+
"type": "string",
|
|
6672
|
+
"description": "Optional type of the relationship as a [Concept ID](../index.md#concept-id).\n\nDefines the semantic meaning of the relationship.\nIf not provided, the relationship has no specific semantics (\"related somehow\").",
|
|
6673
|
+
"anyOf": [
|
|
6674
|
+
{
|
|
6675
|
+
"type": "string",
|
|
6676
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6677
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6678
|
+
}
|
|
6679
|
+
],
|
|
6680
|
+
"examples": [
|
|
6681
|
+
"foo.bar:relationName"
|
|
6682
|
+
]
|
|
6683
|
+
}
|
|
6684
|
+
},
|
|
6685
|
+
"required": [
|
|
6686
|
+
"ordId"
|
|
6687
|
+
],
|
|
6688
|
+
"additionalProperties": false
|
|
6689
|
+
},
|
|
6690
|
+
"RelatedEventResource": {
|
|
6691
|
+
"title": "Related Event Resource",
|
|
6692
|
+
"x-introduced-in-version": "1.14.2",
|
|
6693
|
+
"x-ums-type": "embedded",
|
|
6694
|
+
"type": "object",
|
|
6695
|
+
"description": "Defines a relation to an Event Resource (via its ORD ID).",
|
|
6696
|
+
"properties": {
|
|
6697
|
+
"ordId": {
|
|
6698
|
+
"type": "string",
|
|
6699
|
+
"description": "The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.\n\nIt MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.",
|
|
6700
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(eventResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6701
|
+
"maxLength": 255,
|
|
6702
|
+
"examples": [
|
|
6703
|
+
"sap.s4:eventResource:BusinessPartnerEvents:v1"
|
|
6704
|
+
],
|
|
6705
|
+
"x-association-target": [
|
|
6706
|
+
"#/definitions/EventResource/ordId"
|
|
6707
|
+
]
|
|
6708
|
+
},
|
|
6709
|
+
"relationType": {
|
|
6710
|
+
"type": "string",
|
|
6711
|
+
"description": "Optional type of the relationship as a [Concept ID](../index.md#concept-id).\n\nDefines the semantic meaning of the relationship.\nIf not provided, the relationship has no specific semantics (\"related somehow\").",
|
|
6712
|
+
"anyOf": [
|
|
6713
|
+
{
|
|
6714
|
+
"type": "string",
|
|
6715
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6716
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6717
|
+
}
|
|
6718
|
+
],
|
|
6719
|
+
"examples": [
|
|
6720
|
+
"foo.bar:relationName"
|
|
6721
|
+
]
|
|
6722
|
+
}
|
|
6723
|
+
},
|
|
6724
|
+
"required": [
|
|
6725
|
+
"ordId"
|
|
6726
|
+
],
|
|
6727
|
+
"additionalProperties": false
|
|
6728
|
+
},
|
|
6729
|
+
"RelatedCapability": {
|
|
6730
|
+
"title": "Related Capability",
|
|
6731
|
+
"x-introduced-in-version": "1.14.2",
|
|
6732
|
+
"x-ums-type": "embedded",
|
|
6733
|
+
"type": "object",
|
|
6734
|
+
"description": "Defines a relation to another Capability (via its ORD ID).",
|
|
6735
|
+
"properties": {
|
|
6736
|
+
"ordId": {
|
|
6737
|
+
"type": "string",
|
|
6738
|
+
"description": "The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.\n\nIt MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.",
|
|
6739
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(capability):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6740
|
+
"maxLength": 255,
|
|
6741
|
+
"examples": [
|
|
6742
|
+
"sap.foo:capability:fieldExtensibility:v1"
|
|
6743
|
+
],
|
|
6744
|
+
"x-association-target": [
|
|
6745
|
+
"#/definitions/Capability/ordId"
|
|
6746
|
+
]
|
|
6747
|
+
},
|
|
6748
|
+
"relationType": {
|
|
6749
|
+
"type": "string",
|
|
6750
|
+
"description": "Optional type of the relationship as a [Concept ID](../index.md#concept-id).\n\nDefines the semantic meaning of the relationship.\nIf not provided, the relationship has no specific semantics (\"related somehow\").",
|
|
6751
|
+
"anyOf": [
|
|
6752
|
+
{
|
|
6753
|
+
"type": "string",
|
|
6754
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6755
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6756
|
+
}
|
|
6757
|
+
],
|
|
6758
|
+
"examples": [
|
|
6759
|
+
"foo.bar:relationName"
|
|
6417
6760
|
]
|
|
6418
6761
|
}
|
|
6419
6762
|
},
|
|
@@ -6509,10 +6852,7 @@
|
|
|
6509
6852
|
"description": {
|
|
6510
6853
|
"type": "string",
|
|
6511
6854
|
"minLength": 1,
|
|
6512
|
-
"description": "Optional description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description of a Tombstone MAY be added to the changelog of the removed resource by an ORD aggregator."
|
|
6513
|
-
"examples": [
|
|
6514
|
-
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for\nin-memory computing, acts as a digital core, connecting your\nenterprise with people, business networks, the Internet of Things,\nBig Data, and more.\n"
|
|
6515
|
-
]
|
|
6855
|
+
"description": "Optional description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nThe description of a Tombstone MAY be added to the changelog of the removed resource by an ORD aggregator."
|
|
6516
6856
|
}
|
|
6517
6857
|
},
|
|
6518
6858
|
"required": [
|
|
@@ -6641,9 +6981,14 @@
|
|
|
6641
6981
|
"type": "string",
|
|
6642
6982
|
"description": "Defines the maturity level and stability commitment for the resource's API contract (interface, behavior, data models).\n\nThis indicates whether the resource may undergo backward-incompatible changes. It helps consumers understand the risk\nof depending on the resource and whether it's suitable for production use.\n\nNote: This is independent of `visibility` and does not imply availability guarantees or SLAs - it concerns only the API contract stability.\n\nSee [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.",
|
|
6643
6983
|
"oneOf": [
|
|
6984
|
+
{
|
|
6985
|
+
"const": "development",
|
|
6986
|
+
"x-introduced-in-version": "1.14.2",
|
|
6987
|
+
"description": "The resource is unreleased and under active development. The API contract is unstable and subject to\nbreaking changes at any time. Not intended for consumption outside of the development team."
|
|
6988
|
+
},
|
|
6644
6989
|
{
|
|
6645
6990
|
"const": "beta",
|
|
6646
|
-
"description": "The API contract has no stability guarantees
|
|
6991
|
+
"description": "The API contract is released / available to consumers, but has no final stability guarantees.\nBreaking changes may occur at any time without notice or deprecation period.\n\nNot recommended for production use unless you can tolerate breaking changes. Suitable for experimentation, early adopters,\nand feedback gathering. Resources of `beta` status MAY be changed or removed at the provider's discretion."
|
|
6647
6992
|
},
|
|
6648
6993
|
{
|
|
6649
6994
|
"const": "active",
|
|
@@ -456,7 +456,7 @@ export interface ApiResource {
|
|
|
456
456
|
*
|
|
457
457
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
458
458
|
*/
|
|
459
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
459
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
460
460
|
/**
|
|
461
461
|
* Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.
|
|
462
462
|
* This can happen either because it has not been setup for use or disabled by an admin / user.
|
|
@@ -741,7 +741,7 @@ export interface ChangelogEntry {
|
|
|
741
741
|
*
|
|
742
742
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
743
743
|
*/
|
|
744
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
744
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
745
745
|
/**
|
|
746
746
|
* Date of change, without time or timezone information.
|
|
747
747
|
*
|
|
@@ -1037,7 +1037,7 @@ export interface Link {
|
|
|
1037
1037
|
*/
|
|
1038
1038
|
url: string;
|
|
1039
1039
|
/**
|
|
1040
|
-
* Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown)
|
|
1040
|
+
* Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).
|
|
1041
1041
|
*/
|
|
1042
1042
|
description?: string;
|
|
1043
1043
|
[k: string]: unknown | undefined;
|
|
@@ -1232,7 +1232,7 @@ export interface EventResource {
|
|
|
1232
1232
|
*
|
|
1233
1233
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
1234
1234
|
*/
|
|
1235
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
1235
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
1236
1236
|
/**
|
|
1237
1237
|
* Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.
|
|
1238
1238
|
* This can happen either because it has not been setup for use or disabled by an admin / user.
|
|
@@ -1641,7 +1641,7 @@ export interface EntityType {
|
|
|
1641
1641
|
*
|
|
1642
1642
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
1643
1643
|
*/
|
|
1644
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
1644
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
1645
1645
|
/**
|
|
1646
1646
|
* The deprecation date defines when the resource has been set as deprecated.
|
|
1647
1647
|
* This is not to be confused with the `sunsetDate` which defines when the resource will be actually sunset, aka. decommissioned / removed / archived.
|
|
@@ -1757,8 +1757,10 @@ export interface RelatedEntityType {
|
|
|
1757
1757
|
* Optional type of the relationship, which defines a stricter semantic what the relationship implies.
|
|
1758
1758
|
*
|
|
1759
1759
|
* If not provided, the relationship type has no semantics, it's "related somehow".
|
|
1760
|
+
*
|
|
1761
|
+
* MUST be a valid [Concept ID](../index.md#concept-id).
|
|
1760
1762
|
*/
|
|
1761
|
-
relationType?: "part-of" | "can-share-identity";
|
|
1763
|
+
relationType?: (string | "part-of" | "can-share-identity") & string;
|
|
1762
1764
|
}
|
|
1763
1765
|
/**
|
|
1764
1766
|
* Capabilities can be used to describe use case specific capabilities, most notably supported features or additional information (like configuration) that needs to be understood from outside.
|
|
@@ -1896,7 +1898,7 @@ export interface Capability {
|
|
|
1896
1898
|
*
|
|
1897
1899
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
1898
1900
|
*/
|
|
1899
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
1901
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
1900
1902
|
/**
|
|
1901
1903
|
* Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.
|
|
1902
1904
|
* This can happen either because it has not been setup for use or disabled by an admin / user.
|
|
@@ -1922,6 +1924,24 @@ export interface Capability {
|
|
|
1922
1924
|
* MUST be a valid reference to an [EntityType Resource](#entity-type) ORD ID.
|
|
1923
1925
|
*/
|
|
1924
1926
|
relatedEntityTypes?: string[];
|
|
1927
|
+
/**
|
|
1928
|
+
* Optional list of related API Resources.
|
|
1929
|
+
*
|
|
1930
|
+
* Use this to indicate which APIs implement, expose, or are otherwise related to this capability.
|
|
1931
|
+
*/
|
|
1932
|
+
relatedApiResources?: RelatedAPIResource[];
|
|
1933
|
+
/**
|
|
1934
|
+
* Optional list of related Event Resources.
|
|
1935
|
+
*
|
|
1936
|
+
* Use this to indicate which events are emitted, consumed, or otherwise related to this capability.
|
|
1937
|
+
*/
|
|
1938
|
+
relatedEventResources?: RelatedEventResource[];
|
|
1939
|
+
/**
|
|
1940
|
+
* Optional list of related Capabilities.
|
|
1941
|
+
*
|
|
1942
|
+
* Use this to indicate dependencies, extensions, or other relationships between capabilities.
|
|
1943
|
+
*/
|
|
1944
|
+
relatedCapabilities?: RelatedCapability[];
|
|
1925
1945
|
/**
|
|
1926
1946
|
* List of available machine-readable definitions, which describe the resource or capability in detail.
|
|
1927
1947
|
* See also [Resource Definitions](../index.md#resource-definitions) for more context.
|
|
@@ -1962,6 +1982,60 @@ export interface Capability {
|
|
|
1962
1982
|
*/
|
|
1963
1983
|
systemInstanceAware?: boolean;
|
|
1964
1984
|
}
|
|
1985
|
+
/**
|
|
1986
|
+
* Defines a relation to an API Resource (via its ORD ID).
|
|
1987
|
+
*/
|
|
1988
|
+
export interface RelatedAPIResource {
|
|
1989
|
+
/**
|
|
1990
|
+
* The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.
|
|
1991
|
+
*
|
|
1992
|
+
* It MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.
|
|
1993
|
+
*/
|
|
1994
|
+
ordId: string;
|
|
1995
|
+
/**
|
|
1996
|
+
* Optional type of the relationship as a [Concept ID](../index.md#concept-id).
|
|
1997
|
+
*
|
|
1998
|
+
* Defines the semantic meaning of the relationship.
|
|
1999
|
+
* If not provided, the relationship has no specific semantics ("related somehow").
|
|
2000
|
+
*/
|
|
2001
|
+
relationType?: string;
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* Defines a relation to an Event Resource (via its ORD ID).
|
|
2005
|
+
*/
|
|
2006
|
+
export interface RelatedEventResource {
|
|
2007
|
+
/**
|
|
2008
|
+
* The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.
|
|
2009
|
+
*
|
|
2010
|
+
* It MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.
|
|
2011
|
+
*/
|
|
2012
|
+
ordId: string;
|
|
2013
|
+
/**
|
|
2014
|
+
* Optional type of the relationship as a [Concept ID](../index.md#concept-id).
|
|
2015
|
+
*
|
|
2016
|
+
* Defines the semantic meaning of the relationship.
|
|
2017
|
+
* If not provided, the relationship has no specific semantics ("related somehow").
|
|
2018
|
+
*/
|
|
2019
|
+
relationType?: string;
|
|
2020
|
+
}
|
|
2021
|
+
/**
|
|
2022
|
+
* Defines a relation to another Capability (via its ORD ID).
|
|
2023
|
+
*/
|
|
2024
|
+
export interface RelatedCapability {
|
|
2025
|
+
/**
|
|
2026
|
+
* The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.
|
|
2027
|
+
*
|
|
2028
|
+
* It MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.
|
|
2029
|
+
*/
|
|
2030
|
+
ordId: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* Optional type of the relationship as a [Concept ID](../index.md#concept-id).
|
|
2033
|
+
*
|
|
2034
|
+
* Defines the semantic meaning of the relationship.
|
|
2035
|
+
* If not provided, the relationship has no specific semantics ("related somehow").
|
|
2036
|
+
*/
|
|
2037
|
+
relationType?: string;
|
|
2038
|
+
}
|
|
1965
2039
|
/**
|
|
1966
2040
|
* Link and categorization of a machine-readable capability definition.
|
|
1967
2041
|
*/
|
|
@@ -2141,7 +2215,7 @@ export interface DataProduct {
|
|
|
2141
2215
|
* In the context of data products, it it covers only properties on the data product level.
|
|
2142
2216
|
* APIs that are part of the input and output ports have their own independent `releaseStatus` and `version`.
|
|
2143
2217
|
*/
|
|
2144
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
2218
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
2145
2219
|
/**
|
|
2146
2220
|
* Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.
|
|
2147
2221
|
* This can happen either because it has not been setup for use or disabled by an admin / user.
|
|
@@ -2501,7 +2575,7 @@ export interface Agent {
|
|
|
2501
2575
|
*
|
|
2502
2576
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
2503
2577
|
*/
|
|
2504
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
2578
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
2505
2579
|
/**
|
|
2506
2580
|
* Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.
|
|
2507
2581
|
* This can happen either because it has not been setup for use or disabled by an admin / user.
|
|
@@ -2779,7 +2853,7 @@ export interface IntegrationDependency {
|
|
|
2779
2853
|
*
|
|
2780
2854
|
* See [Lifecycle](../index.md#lifecycle) and [Compatibility](../concepts/compatibility.md) for more details.
|
|
2781
2855
|
*/
|
|
2782
|
-
releaseStatus: "beta" | "active" | "deprecated" | "sunset";
|
|
2856
|
+
releaseStatus: "development" | "beta" | "active" | "deprecated" | "sunset";
|
|
2783
2857
|
/**
|
|
2784
2858
|
* The sunset date defines when the resource is scheduled to be decommissioned / removed / archived.
|
|
2785
2859
|
*
|
|
@@ -2868,6 +2942,10 @@ export interface Aspect {
|
|
|
2868
2942
|
* List of Event Resource Dependencies.
|
|
2869
2943
|
*/
|
|
2870
2944
|
eventResources?: EventResourceIntegrationAspect[];
|
|
2945
|
+
/**
|
|
2946
|
+
* List of Capability Dependencies.
|
|
2947
|
+
*/
|
|
2948
|
+
capabilities?: CapabilityIntegrationAspect[];
|
|
2871
2949
|
}
|
|
2872
2950
|
/**
|
|
2873
2951
|
* API resource related integration aspect
|
|
@@ -2948,6 +3026,22 @@ export interface EventResourceIntegrationAspectSubset {
|
|
|
2948
3026
|
*/
|
|
2949
3027
|
eventType: string;
|
|
2950
3028
|
}
|
|
3029
|
+
/**
|
|
3030
|
+
* Capability related integration aspect
|
|
3031
|
+
*/
|
|
3032
|
+
export interface CapabilityIntegrationAspect {
|
|
3033
|
+
/**
|
|
3034
|
+
* The ORD ID is a stable, globally unique ID for ORD resources or taxonomy.
|
|
3035
|
+
*
|
|
3036
|
+
* It MUST be a valid [ORD ID](../index.md#ord-id) of the appropriate ORD type.
|
|
3037
|
+
*/
|
|
3038
|
+
ordId: string;
|
|
3039
|
+
/**
|
|
3040
|
+
* Minimum version of the references resource that the integration requires.
|
|
3041
|
+
*
|
|
3042
|
+
*/
|
|
3043
|
+
minVersion?: string;
|
|
3044
|
+
}
|
|
2951
3045
|
/**
|
|
2952
3046
|
* The vendor of a product or a package, usually a corporation or a customer / user.
|
|
2953
3047
|
*
|
|
@@ -3171,6 +3265,10 @@ export interface Package {
|
|
|
3171
3265
|
* `packageLinks` MUST be preferred if applicable.
|
|
3172
3266
|
*/
|
|
3173
3267
|
links?: Link[];
|
|
3268
|
+
/**
|
|
3269
|
+
* Generic list of files with arbitrary meaning and content. Meant to be used for linking PDFs, Word or similar content. This option MUST NOT be used for linking the actual metadata files like OpenAPI, AsyncAPI, CSN, etc.
|
|
3270
|
+
*/
|
|
3271
|
+
files?: File[];
|
|
3174
3272
|
/**
|
|
3175
3273
|
* Standardized identifier for the license.
|
|
3176
3274
|
* It MUST conform to the [SPDX License List](https://spdx.org/licenses).
|
|
@@ -3267,6 +3365,42 @@ export interface PackageLink {
|
|
|
3267
3365
|
url: string;
|
|
3268
3366
|
[k: string]: unknown | undefined;
|
|
3269
3367
|
}
|
|
3368
|
+
/**
|
|
3369
|
+
* File that can be attached on ORD package level.
|
|
3370
|
+
*
|
|
3371
|
+
*/
|
|
3372
|
+
export interface File {
|
|
3373
|
+
/**
|
|
3374
|
+
* Human readable title of the file.
|
|
3375
|
+
*
|
|
3376
|
+
* MUST be unique within the collection of files provided.
|
|
3377
|
+
*/
|
|
3378
|
+
title: string;
|
|
3379
|
+
/**
|
|
3380
|
+
* [URL](https://tools.ietf.org/html/rfc3986) of the link.
|
|
3381
|
+
*
|
|
3382
|
+
* The file target MAY be relative or absolute.
|
|
3383
|
+
* If a relative URL is given, it is relative to the [`describedSystemInstance.baseUrl`](#system-instance_baseurl).
|
|
3384
|
+
* If an absolute URL is given, then it MUST be openly accessible.
|
|
3385
|
+
*/
|
|
3386
|
+
url: string;
|
|
3387
|
+
/**
|
|
3388
|
+
* Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).
|
|
3389
|
+
*
|
|
3390
|
+
* The description SHOULD not be excessive in length and is not meant to provide full documentation.
|
|
3391
|
+
* Detailed documentation SHOULD be attached as (typed) links.
|
|
3392
|
+
*/
|
|
3393
|
+
description?: string;
|
|
3394
|
+
/**
|
|
3395
|
+
* The [Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the definition serialization format.
|
|
3396
|
+
* A consuming application can use this information to know which file format parser it needs to use.
|
|
3397
|
+
*
|
|
3398
|
+
* If no Media Type is registered for the referenced file, `text/plain` MAY be used for arbitrary plain-text and `application/octet-stream` for arbitrary binary data.
|
|
3399
|
+
*
|
|
3400
|
+
*/
|
|
3401
|
+
mediaType: string;
|
|
3402
|
+
[k: string]: unknown | undefined;
|
|
3403
|
+
}
|
|
3270
3404
|
/**
|
|
3271
3405
|
* A [**Consumption Bundle**](../concepts/grouping-and-bundling#consumption-bundle) groups APIs and Events together that can be consumed with the credentials and auth mechanism.
|
|
3272
3406
|
* Ideally it also includes instructions and details how to request access and credentials for resources.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json.schemastore.org/package",
|
|
3
3
|
"name": "@open-resource-discovery/specification",
|
|
4
|
-
"version": "1.14.
|
|
4
|
+
"version": "1.14.2",
|
|
5
5
|
"description": "Open Resource Discovery (ORD) Specification",
|
|
6
6
|
"author": "SAP SE",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -38,14 +38,14 @@
|
|
|
38
38
|
"postgenerate": "ts-node ./src/helper/copyGeneratedToDestination.ts"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@biomejs/biome": "2.4.
|
|
41
|
+
"@biomejs/biome": "2.4.9",
|
|
42
42
|
"@docusaurus/core": "3.9.2",
|
|
43
43
|
"@docusaurus/plugin-client-redirects": "3.9.2",
|
|
44
44
|
"@docusaurus/preset-classic": "3.9.2",
|
|
45
45
|
"@docusaurus/theme-mermaid": "3.9.2",
|
|
46
46
|
"@easyops-cn/docusaurus-search-local": "0.55.1",
|
|
47
47
|
"@mdx-js/react": "3.1.1",
|
|
48
|
-
"@open-resource-discovery/spec-toolkit": "0.
|
|
48
|
+
"@open-resource-discovery/spec-toolkit": "0.8.0",
|
|
49
49
|
"@types/fs-extra": "11.0.4",
|
|
50
50
|
"ajv": "8.18.0",
|
|
51
51
|
"ajv-formats": "3.0.1",
|