@open-resource-discovery/specification 1.14.1 → 1.14.3
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.
|
@@ -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,
|
|
@@ -673,7 +689,7 @@
|
|
|
673
689
|
"type": "object",
|
|
674
690
|
"title": "Consumption Bundle",
|
|
675
691
|
"x-ums-type": "root",
|
|
676
|
-
"description": "A [**Consumption Bundle**](../concepts/grouping-and-bundling#consumption-bundle) groups APIs and Events together that can be consumed with the credentials and auth mechanism.\nIdeally it also includes instructions and details how to request access and credentials for resources.\n\nFor more documentation and guidance how to
|
|
692
|
+
"description": "A [**Consumption Bundle**](../concepts/grouping-and-bundling#consumption-bundle) groups APIs and Events together that can be consumed with the same credentials and auth mechanism.\nIdeally it also includes instructions and details on how to request access and credentials for resources.\n\nFor more documentation and guidance on how to use this correctly, see [Consumption Bundle](../concepts/grouping-and-bundling#consumption-bundle).\n\nA Consumption Bundle SHOULD have at least one association with a resource (0..n). Avoid empty Consumption Bundles.\nA Consumption Bundle MUST NOT contain APIs and Events that are NOT defined in the ORD document(s) returned\nby the system instance that defines the Consumption Bundle.\n\nPlease note that some ORD consumer use cases MAY depend on Consumption Bundle assignments to work with the resources.\n\nTo learn more about the concept, see [Consumption Bundle](../concepts/grouping-and-bundling#consumption-bundle).",
|
|
677
693
|
"properties": {
|
|
678
694
|
"ordId": {
|
|
679
695
|
"type": "string",
|
|
@@ -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",
|
|
@@ -1061,6 +1082,38 @@
|
|
|
1061
1082
|
"2024.8.0"
|
|
1062
1083
|
]
|
|
1063
1084
|
},
|
|
1085
|
+
"relatedApiResources": {
|
|
1086
|
+
"type": "array",
|
|
1087
|
+
"x-introduced-in-version": "1.14.3",
|
|
1088
|
+
"description": "Optional list of related API Resources.\n\nUse this to indicate which APIs implement, expose, or are otherwise related to this entity.",
|
|
1089
|
+
"items": {
|
|
1090
|
+
"$ref": "#/definitions/RelatedApiResource"
|
|
1091
|
+
},
|
|
1092
|
+
"examples": [
|
|
1093
|
+
[
|
|
1094
|
+
{
|
|
1095
|
+
"ordId": "sap.s4:apiResource:API_BUSINESS_PARTNER:v1",
|
|
1096
|
+
"relationType": "foo.bar:relationName"
|
|
1097
|
+
}
|
|
1098
|
+
]
|
|
1099
|
+
]
|
|
1100
|
+
},
|
|
1101
|
+
"relatedEventResources": {
|
|
1102
|
+
"type": "array",
|
|
1103
|
+
"x-introduced-in-version": "1.14.3",
|
|
1104
|
+
"description": "Optional list of related Event Resources.\n\nUse this to indicate which events are emitted, consumed, or otherwise related to this entity.",
|
|
1105
|
+
"items": {
|
|
1106
|
+
"$ref": "#/definitions/RelatedEventResource"
|
|
1107
|
+
},
|
|
1108
|
+
"examples": [
|
|
1109
|
+
[
|
|
1110
|
+
{
|
|
1111
|
+
"ordId": "sap.s4:eventResource:BusinessPartnerEvents:v1",
|
|
1112
|
+
"relationType": "foo.bar:relationName"
|
|
1113
|
+
}
|
|
1114
|
+
]
|
|
1115
|
+
]
|
|
1116
|
+
},
|
|
1064
1117
|
"deprecationDate": {
|
|
1065
1118
|
"type": "string",
|
|
1066
1119
|
"format": "date-time",
|
|
@@ -1335,6 +1388,8 @@
|
|
|
1335
1388
|
"entityTypeMappings": {
|
|
1336
1389
|
"type": "array",
|
|
1337
1390
|
"x-introduced-in-version": "1.6.0",
|
|
1391
|
+
"x-deprecated-in-version": "1.11.0",
|
|
1392
|
+
"x-deprecation-text": "Use the simplified `exposedEntityTypes` instead.",
|
|
1338
1393
|
"description": "Describes mappings between the API Models of the described resource to the underlying, conceptual entity types.",
|
|
1339
1394
|
"items": {
|
|
1340
1395
|
"$ref": "#/definitions/EntityTypeMapping"
|
|
@@ -1628,6 +1683,8 @@
|
|
|
1628
1683
|
],
|
|
1629
1684
|
"default": "none",
|
|
1630
1685
|
"x-introduced-in-version": "1.3.0",
|
|
1686
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
1687
|
+
"x-deprecated-in-version": "1.9.9",
|
|
1631
1688
|
"examples": [
|
|
1632
1689
|
"sap:core:v1"
|
|
1633
1690
|
]
|
|
@@ -1638,6 +1695,8 @@
|
|
|
1638
1695
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
1639
1696
|
"maxLength": 255,
|
|
1640
1697
|
"x-introduced-in-version": "1.3.0",
|
|
1698
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
1699
|
+
"x-deprecated-in-version": "1.9.9",
|
|
1641
1700
|
"examples": [
|
|
1642
1701
|
"sap.xref:customPolicy:v1"
|
|
1643
1702
|
]
|
|
@@ -1659,6 +1718,8 @@
|
|
|
1659
1718
|
"type": "boolean",
|
|
1660
1719
|
"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
1720
|
"default": false,
|
|
1721
|
+
"x-deprecated-in-version": "1.12.0",
|
|
1722
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
1662
1723
|
"examples": [
|
|
1663
1724
|
true
|
|
1664
1725
|
]
|
|
@@ -1857,9 +1918,14 @@
|
|
|
1857
1918
|
"type": "string",
|
|
1858
1919
|
"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
1920
|
"oneOf": [
|
|
1921
|
+
{
|
|
1922
|
+
"const": "development",
|
|
1923
|
+
"x-introduced-in-version": "1.14.2",
|
|
1924
|
+
"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."
|
|
1925
|
+
},
|
|
1860
1926
|
{
|
|
1861
1927
|
"const": "beta",
|
|
1862
|
-
"description": "The API contract has no stability guarantees
|
|
1928
|
+
"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
1929
|
},
|
|
1864
1930
|
{
|
|
1865
1931
|
"const": "active",
|
|
@@ -1893,6 +1959,38 @@
|
|
|
1893
1959
|
"2024.8.0"
|
|
1894
1960
|
]
|
|
1895
1961
|
},
|
|
1962
|
+
"relatedApiResources": {
|
|
1963
|
+
"type": "array",
|
|
1964
|
+
"x-introduced-in-version": "1.14.3",
|
|
1965
|
+
"description": "Optional list of related API Resources.\n\nUse this to indicate which APIs implement, expose, or are otherwise related to this entity.",
|
|
1966
|
+
"items": {
|
|
1967
|
+
"$ref": "#/definitions/RelatedApiResource"
|
|
1968
|
+
},
|
|
1969
|
+
"examples": [
|
|
1970
|
+
[
|
|
1971
|
+
{
|
|
1972
|
+
"ordId": "sap.s4:apiResource:API_BUSINESS_PARTNER:v1",
|
|
1973
|
+
"relationType": "foo.bar:relationName"
|
|
1974
|
+
}
|
|
1975
|
+
]
|
|
1976
|
+
]
|
|
1977
|
+
},
|
|
1978
|
+
"relatedEventResources": {
|
|
1979
|
+
"type": "array",
|
|
1980
|
+
"x-introduced-in-version": "1.14.3",
|
|
1981
|
+
"description": "Optional list of related Event Resources.\n\nUse this to indicate which events are emitted, consumed, or otherwise related to this entity.",
|
|
1982
|
+
"items": {
|
|
1983
|
+
"$ref": "#/definitions/RelatedEventResource"
|
|
1984
|
+
},
|
|
1985
|
+
"examples": [
|
|
1986
|
+
[
|
|
1987
|
+
{
|
|
1988
|
+
"ordId": "sap.s4:eventResource:BusinessPartnerEvents:v1",
|
|
1989
|
+
"relationType": "foo.bar:relationName"
|
|
1990
|
+
}
|
|
1991
|
+
]
|
|
1992
|
+
]
|
|
1993
|
+
},
|
|
1896
1994
|
"deprecationDate": {
|
|
1897
1995
|
"type": "string",
|
|
1898
1996
|
"format": "date-time",
|
|
@@ -2012,6 +2110,8 @@
|
|
|
2012
2110
|
"entityTypeMappings": {
|
|
2013
2111
|
"type": "array",
|
|
2014
2112
|
"x-introduced-in-version": "1.6.0",
|
|
2113
|
+
"x-deprecated-in-version": "1.11.0",
|
|
2114
|
+
"x-deprecation-text": "Use the simplified `exposedEntityTypes` instead.",
|
|
2015
2115
|
"description": "Describes mappings between the API Models of the described resource to the underlying, conceptual entity types.",
|
|
2016
2116
|
"items": {
|
|
2017
2117
|
"$ref": "#/definitions/EntityTypeMapping"
|
|
@@ -2306,6 +2406,8 @@
|
|
|
2306
2406
|
],
|
|
2307
2407
|
"default": "none",
|
|
2308
2408
|
"x-introduced-in-version": "1.3.0",
|
|
2409
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2410
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2309
2411
|
"examples": [
|
|
2310
2412
|
"sap:core:v1"
|
|
2311
2413
|
]
|
|
@@ -2316,6 +2418,8 @@
|
|
|
2316
2418
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
2317
2419
|
"maxLength": 255,
|
|
2318
2420
|
"x-introduced-in-version": "1.3.0",
|
|
2421
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2422
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2319
2423
|
"examples": [
|
|
2320
2424
|
"sap.xref:customPolicy:v1"
|
|
2321
2425
|
]
|
|
@@ -2337,6 +2441,8 @@
|
|
|
2337
2441
|
"type": "boolean",
|
|
2338
2442
|
"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
2443
|
"default": false,
|
|
2444
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2445
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2340
2446
|
"examples": [
|
|
2341
2447
|
true
|
|
2342
2448
|
]
|
|
@@ -2361,7 +2467,7 @@
|
|
|
2361
2467
|
"type": "object",
|
|
2362
2468
|
"title": "Entity Type",
|
|
2363
2469
|
"x-ums-type": "root",
|
|
2364
|
-
"description": "An [**Entity Type**](../concepts/grouping-and-bundling#entity-type) describes either a business concept / term or an underlying conceptual model
|
|
2470
|
+
"description": "An [**Entity Type**](../concepts/grouping-and-bundling#entity-type) describes either a business concept / term or an underlying conceptual model (e.g. a business object / domain model).\nEntity Types can be related to API & Event resources, Data Products and other Entity Types, connecting exposed resources to business semantics.\n\nTo learn more about the concept, see [Entity Type](../concepts/grouping-and-bundling#entity-type).",
|
|
2365
2471
|
"x-introduced-in-version": "1.8.0",
|
|
2366
2472
|
"properties": {
|
|
2367
2473
|
"ordId": {
|
|
@@ -2519,9 +2625,14 @@
|
|
|
2519
2625
|
"type": "string",
|
|
2520
2626
|
"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
2627
|
"oneOf": [
|
|
2628
|
+
{
|
|
2629
|
+
"const": "development",
|
|
2630
|
+
"x-introduced-in-version": "1.14.2",
|
|
2631
|
+
"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."
|
|
2632
|
+
},
|
|
2522
2633
|
{
|
|
2523
2634
|
"const": "beta",
|
|
2524
|
-
"description": "The API contract has no stability guarantees
|
|
2635
|
+
"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
2636
|
},
|
|
2526
2637
|
{
|
|
2527
2638
|
"const": "active",
|
|
@@ -2673,6 +2784,8 @@
|
|
|
2673
2784
|
],
|
|
2674
2785
|
"default": "none",
|
|
2675
2786
|
"x-introduced-in-version": "1.3.0",
|
|
2787
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2788
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2676
2789
|
"examples": [
|
|
2677
2790
|
"sap:core:v1"
|
|
2678
2791
|
]
|
|
@@ -2683,6 +2796,8 @@
|
|
|
2683
2796
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
2684
2797
|
"maxLength": 255,
|
|
2685
2798
|
"x-introduced-in-version": "1.3.0",
|
|
2799
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
2800
|
+
"x-deprecated-in-version": "1.9.9",
|
|
2686
2801
|
"examples": [
|
|
2687
2802
|
"sap.xref:customPolicy:v1"
|
|
2688
2803
|
]
|
|
@@ -2704,6 +2819,8 @@
|
|
|
2704
2819
|
"type": "boolean",
|
|
2705
2820
|
"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
2821
|
"default": false,
|
|
2822
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2823
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2707
2824
|
"examples": [
|
|
2708
2825
|
true
|
|
2709
2826
|
]
|
|
@@ -2872,9 +2989,14 @@
|
|
|
2872
2989
|
"type": "string",
|
|
2873
2990
|
"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
2991
|
"oneOf": [
|
|
2992
|
+
{
|
|
2993
|
+
"const": "development",
|
|
2994
|
+
"x-introduced-in-version": "1.14.2",
|
|
2995
|
+
"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."
|
|
2996
|
+
},
|
|
2875
2997
|
{
|
|
2876
2998
|
"const": "beta",
|
|
2877
|
-
"description": "The API contract has no stability guarantees
|
|
2999
|
+
"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
3000
|
},
|
|
2879
3001
|
{
|
|
2880
3002
|
"const": "active",
|
|
@@ -3384,6 +3506,8 @@
|
|
|
3384
3506
|
],
|
|
3385
3507
|
"default": "none",
|
|
3386
3508
|
"x-introduced-in-version": "1.3.0",
|
|
3509
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
3510
|
+
"x-deprecated-in-version": "1.9.9",
|
|
3387
3511
|
"examples": [
|
|
3388
3512
|
"sap:core:v1"
|
|
3389
3513
|
]
|
|
@@ -3395,6 +3519,8 @@
|
|
|
3395
3519
|
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3396
3520
|
"maxLength": 255,
|
|
3397
3521
|
"x-introduced-in-version": "1.3.0",
|
|
3522
|
+
"x-deprecation-text": "ORD now support multiple policy levels. Use `policyLevels` (plural) instead.",
|
|
3523
|
+
"x-deprecated-in-version": "1.9.9",
|
|
3398
3524
|
"examples": [
|
|
3399
3525
|
"sap.xref:customPolicy:v1"
|
|
3400
3526
|
]
|
|
@@ -3417,6 +3543,8 @@
|
|
|
3417
3543
|
"type": "boolean",
|
|
3418
3544
|
"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
3545
|
"default": false,
|
|
3546
|
+
"x-deprecated-in-version": "1.12.0",
|
|
3547
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
3420
3548
|
"examples": [
|
|
3421
3549
|
true
|
|
3422
3550
|
]
|
|
@@ -3801,10 +3929,7 @@
|
|
|
3801
3929
|
"description": {
|
|
3802
3930
|
"type": "string",
|
|
3803
3931
|
"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
|
-
]
|
|
3932
|
+
"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
3933
|
},
|
|
3809
3934
|
"partOfPackage": {
|
|
3810
3935
|
"type": "string",
|
|
@@ -3869,9 +3994,14 @@
|
|
|
3869
3994
|
"type": "string",
|
|
3870
3995
|
"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
3996
|
"oneOf": [
|
|
3997
|
+
{
|
|
3998
|
+
"const": "development",
|
|
3999
|
+
"x-introduced-in-version": "1.14.2",
|
|
4000
|
+
"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."
|
|
4001
|
+
},
|
|
3872
4002
|
{
|
|
3873
4003
|
"const": "beta",
|
|
3874
|
-
"description": "The API contract has no stability guarantees
|
|
4004
|
+
"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
4005
|
},
|
|
3876
4006
|
{
|
|
3877
4007
|
"const": "active",
|
|
@@ -4281,7 +4411,7 @@
|
|
|
4281
4411
|
"type": "object",
|
|
4282
4412
|
"title": "Product",
|
|
4283
4413
|
"x-ums-type": "root",
|
|
4284
|
-
"description": "A **product
|
|
4414
|
+
"description": "A [**Product**](../concepts/grouping-and-bundling#product) in ORD is understood as a software product or service offering (whether commercial or free).\n\nIt is a high-level entity for structuring the software portfolio from a portfolio / software logistics perspective.\nWhile **system type** is a technical concept, **product** covers the portfolio and marketing view.\n\nPlease note that the ORD concept of a product is very simple on purpose.\nThere is no distinction between products and services and concepts like product versions, variants, etc.\n\nORD assumes that this is handled by specialized systems and that ORD only provides the means to correlate to them.\n\nTo learn more about the concept, see [Product](../concepts/grouping-and-bundling#product).",
|
|
4285
4415
|
"properties": {
|
|
4286
4416
|
"ordId": {
|
|
4287
4417
|
"type": "string",
|
|
@@ -4477,10 +4607,7 @@
|
|
|
4477
4607
|
"description": {
|
|
4478
4608
|
"type": "string",
|
|
4479
4609
|
"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
|
-
]
|
|
4610
|
+
"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
4611
|
},
|
|
4485
4612
|
"partOfPackage": {
|
|
4486
4613
|
"type": "string",
|
|
@@ -4545,9 +4672,14 @@
|
|
|
4545
4672
|
"type": "string",
|
|
4546
4673
|
"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
4674
|
"oneOf": [
|
|
4675
|
+
{
|
|
4676
|
+
"const": "development",
|
|
4677
|
+
"x-introduced-in-version": "1.14.2",
|
|
4678
|
+
"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."
|
|
4679
|
+
},
|
|
4548
4680
|
{
|
|
4549
4681
|
"const": "beta",
|
|
4550
|
-
"description": "The API contract has no stability guarantees
|
|
4682
|
+
"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
4683
|
},
|
|
4552
4684
|
{
|
|
4553
4685
|
"const": "active",
|
|
@@ -4597,6 +4729,54 @@
|
|
|
4597
4729
|
]
|
|
4598
4730
|
]
|
|
4599
4731
|
},
|
|
4732
|
+
"relatedApiResources": {
|
|
4733
|
+
"type": "array",
|
|
4734
|
+
"x-introduced-in-version": "1.14.2",
|
|
4735
|
+
"description": "Optional list of related API Resources.\n\nUse this to indicate which APIs implement, expose, or are otherwise related to this entity.",
|
|
4736
|
+
"items": {
|
|
4737
|
+
"$ref": "#/definitions/RelatedApiResource"
|
|
4738
|
+
},
|
|
4739
|
+
"examples": [
|
|
4740
|
+
[
|
|
4741
|
+
{
|
|
4742
|
+
"ordId": "sap.s4:apiResource:API_BUSINESS_PARTNER:v1",
|
|
4743
|
+
"relationType": "foo.bar:relationName"
|
|
4744
|
+
}
|
|
4745
|
+
]
|
|
4746
|
+
]
|
|
4747
|
+
},
|
|
4748
|
+
"relatedEventResources": {
|
|
4749
|
+
"type": "array",
|
|
4750
|
+
"x-introduced-in-version": "1.14.2",
|
|
4751
|
+
"description": "Optional list of related Event Resources.\n\nUse this to indicate which events are emitted, consumed, or otherwise related to this entity.",
|
|
4752
|
+
"items": {
|
|
4753
|
+
"$ref": "#/definitions/RelatedEventResource"
|
|
4754
|
+
},
|
|
4755
|
+
"examples": [
|
|
4756
|
+
[
|
|
4757
|
+
{
|
|
4758
|
+
"ordId": "sap.s4:eventResource:BusinessPartnerEvents:v1",
|
|
4759
|
+
"relationType": "foo.bar:relationName"
|
|
4760
|
+
}
|
|
4761
|
+
]
|
|
4762
|
+
]
|
|
4763
|
+
},
|
|
4764
|
+
"relatedCapabilities": {
|
|
4765
|
+
"type": "array",
|
|
4766
|
+
"x-introduced-in-version": "1.14.2",
|
|
4767
|
+
"description": "Optional list of related Capabilities.\n\nUse this to indicate dependencies, extensions, or other relationships between capabilities.",
|
|
4768
|
+
"items": {
|
|
4769
|
+
"$ref": "#/definitions/RelatedCapability"
|
|
4770
|
+
},
|
|
4771
|
+
"examples": [
|
|
4772
|
+
[
|
|
4773
|
+
{
|
|
4774
|
+
"ordId": "sap.foo:capability:baseExtensibility:v1",
|
|
4775
|
+
"relationType": "foo.bar:relationName"
|
|
4776
|
+
}
|
|
4777
|
+
]
|
|
4778
|
+
]
|
|
4779
|
+
},
|
|
4600
4780
|
"definitions": {
|
|
4601
4781
|
"type": "array",
|
|
4602
4782
|
"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 +4816,8 @@
|
|
|
4636
4816
|
"type": "boolean",
|
|
4637
4817
|
"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
4818
|
"default": false,
|
|
4819
|
+
"x-deprecated-in-version": "1.12.0",
|
|
4820
|
+
"x-deprecation-text": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
4639
4821
|
"examples": [
|
|
4640
4822
|
true
|
|
4641
4823
|
]
|
|
@@ -4813,10 +4995,7 @@
|
|
|
4813
4995
|
"description": {
|
|
4814
4996
|
"type": "string",
|
|
4815
4997
|
"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
|
-
]
|
|
4998
|
+
"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
4999
|
},
|
|
4821
5000
|
"partOfPackage": {
|
|
4822
5001
|
"type": "string",
|
|
@@ -4881,9 +5060,14 @@
|
|
|
4881
5060
|
"type": "string",
|
|
4882
5061
|
"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
5062
|
"oneOf": [
|
|
5063
|
+
{
|
|
5064
|
+
"const": "development",
|
|
5065
|
+
"x-introduced-in-version": "1.14.2",
|
|
5066
|
+
"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."
|
|
5067
|
+
},
|
|
4884
5068
|
{
|
|
4885
5069
|
"const": "beta",
|
|
4886
|
-
"description": "The API contract has no stability guarantees
|
|
5070
|
+
"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
5071
|
},
|
|
4888
5072
|
{
|
|
4889
5073
|
"const": "active",
|
|
@@ -5013,10 +5197,7 @@
|
|
|
5013
5197
|
"description": {
|
|
5014
5198
|
"type": "string",
|
|
5015
5199
|
"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
|
-
]
|
|
5200
|
+
"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
5201
|
},
|
|
5021
5202
|
"mandatory": {
|
|
5022
5203
|
"type": "boolean",
|
|
@@ -5039,6 +5220,13 @@
|
|
|
5039
5220
|
"items": {
|
|
5040
5221
|
"$ref": "#/definitions/EventResourceIntegrationAspect"
|
|
5041
5222
|
}
|
|
5223
|
+
},
|
|
5224
|
+
"capabilities": {
|
|
5225
|
+
"type": "array",
|
|
5226
|
+
"description": "List of Capability Dependencies.",
|
|
5227
|
+
"items": {
|
|
5228
|
+
"$ref": "#/definitions/CapabilityIntegrationAspect"
|
|
5229
|
+
}
|
|
5042
5230
|
}
|
|
5043
5231
|
},
|
|
5044
5232
|
"additionalProperties": false,
|
|
@@ -5179,6 +5367,37 @@
|
|
|
5179
5367
|
"operationId"
|
|
5180
5368
|
]
|
|
5181
5369
|
},
|
|
5370
|
+
"CapabilityIntegrationAspect": {
|
|
5371
|
+
"type": "object",
|
|
5372
|
+
"title": "Capability Integration Aspect",
|
|
5373
|
+
"x-introduced-in-version": "1.14.2",
|
|
5374
|
+
"x-ums-type": "custom",
|
|
5375
|
+
"description": "Capability related integration aspect",
|
|
5376
|
+
"properties": {
|
|
5377
|
+
"ordId": {
|
|
5378
|
+
"type": "string",
|
|
5379
|
+
"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.",
|
|
5380
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(capability):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
5381
|
+
"maxLength": 255,
|
|
5382
|
+
"examples": [
|
|
5383
|
+
"sap.foo.bar:capability:fieldExtensibility:v1"
|
|
5384
|
+
]
|
|
5385
|
+
},
|
|
5386
|
+
"minVersion": {
|
|
5387
|
+
"type": "string",
|
|
5388
|
+
"description": "Minimum version of the references resource that the integration requires.\n",
|
|
5389
|
+
"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-]+)*))?$",
|
|
5390
|
+
"examples": [
|
|
5391
|
+
"1.2.3",
|
|
5392
|
+
"1.0.0-alpha.1"
|
|
5393
|
+
]
|
|
5394
|
+
}
|
|
5395
|
+
},
|
|
5396
|
+
"additionalProperties": false,
|
|
5397
|
+
"required": [
|
|
5398
|
+
"ordId"
|
|
5399
|
+
]
|
|
5400
|
+
},
|
|
5182
5401
|
"Vendor": {
|
|
5183
5402
|
"type": "object",
|
|
5184
5403
|
"title": "Vendor",
|
|
@@ -5267,9 +5486,14 @@
|
|
|
5267
5486
|
"type": "string",
|
|
5268
5487
|
"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
5488
|
"oneOf": [
|
|
5489
|
+
{
|
|
5490
|
+
"const": "development",
|
|
5491
|
+
"x-introduced-in-version": "1.14.2",
|
|
5492
|
+
"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."
|
|
5493
|
+
},
|
|
5270
5494
|
{
|
|
5271
5495
|
"const": "beta",
|
|
5272
|
-
"description": "The API contract has no stability guarantees
|
|
5496
|
+
"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
5497
|
},
|
|
5274
5498
|
{
|
|
5275
5499
|
"const": "active",
|
|
@@ -5342,7 +5566,7 @@
|
|
|
5342
5566
|
"description": {
|
|
5343
5567
|
"type": "string",
|
|
5344
5568
|
"minLength": 1,
|
|
5345
|
-
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown)",
|
|
5569
|
+
"description": "Full description, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).",
|
|
5346
5570
|
"examples": [
|
|
5347
5571
|
"This gives you an overview on where to find which kind of APIs in SAP S/4HANA.\n"
|
|
5348
5572
|
]
|
|
@@ -5360,6 +5584,62 @@
|
|
|
5360
5584
|
}
|
|
5361
5585
|
]
|
|
5362
5586
|
},
|
|
5587
|
+
"File": {
|
|
5588
|
+
"type": "object",
|
|
5589
|
+
"title": "File",
|
|
5590
|
+
"x-introduced-in-version": "1.14.2",
|
|
5591
|
+
"description": "File that can be attached on ORD package level.\n",
|
|
5592
|
+
"x-ums-type": "custom",
|
|
5593
|
+
"properties": {
|
|
5594
|
+
"title": {
|
|
5595
|
+
"type": "string",
|
|
5596
|
+
"minLength": 1,
|
|
5597
|
+
"description": "Human readable title of the file.\n\nMUST be unique within the collection of files provided.",
|
|
5598
|
+
"examples": [
|
|
5599
|
+
"Developer Guide for SAP Ariba Portal"
|
|
5600
|
+
]
|
|
5601
|
+
},
|
|
5602
|
+
"url": {
|
|
5603
|
+
"type": "string",
|
|
5604
|
+
"format": "uri-reference",
|
|
5605
|
+
"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.",
|
|
5606
|
+
"examples": [
|
|
5607
|
+
"/ord/v1/Ariba/Files/DeveloperPortal/SAP-Ariba-developer-portal.pdf"
|
|
5608
|
+
]
|
|
5609
|
+
},
|
|
5610
|
+
"description": {
|
|
5611
|
+
"type": "string",
|
|
5612
|
+
"minLength": 1,
|
|
5613
|
+
"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.",
|
|
5614
|
+
"examples": [
|
|
5615
|
+
"Includes administrator, quick start, and authentication guides.\n"
|
|
5616
|
+
]
|
|
5617
|
+
},
|
|
5618
|
+
"mediaType": {
|
|
5619
|
+
"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",
|
|
5620
|
+
"type": "string",
|
|
5621
|
+
"pattern": "^(application|text)\\/[a-zA-Z0-9][a-zA-Z0-9.+\\-]*$",
|
|
5622
|
+
"examples": [
|
|
5623
|
+
"application/json",
|
|
5624
|
+
"text/plain",
|
|
5625
|
+
"application/xml"
|
|
5626
|
+
]
|
|
5627
|
+
}
|
|
5628
|
+
},
|
|
5629
|
+
"required": [
|
|
5630
|
+
"title",
|
|
5631
|
+
"url",
|
|
5632
|
+
"mediaType"
|
|
5633
|
+
],
|
|
5634
|
+
"examples": [
|
|
5635
|
+
{
|
|
5636
|
+
"url": "/ord/v1/Ariba/Files/DeveloperPortal/SAP-Ariba-developer-portal.pdf",
|
|
5637
|
+
"title": "Developer Guide for SAP Ariba Portal",
|
|
5638
|
+
"description": "Includes administrator, quick start, and authentication guides.",
|
|
5639
|
+
"mediaType": "application/pdf"
|
|
5640
|
+
}
|
|
5641
|
+
]
|
|
5642
|
+
},
|
|
5363
5643
|
"PackageLink": {
|
|
5364
5644
|
"type": "object",
|
|
5365
5645
|
"title": "Package Link",
|
|
@@ -5889,7 +6169,7 @@
|
|
|
5889
6169
|
"Labels": {
|
|
5890
6170
|
"title": "Labels",
|
|
5891
6171
|
"type": "object",
|
|
5892
|
-
"description": "Generic labels that can be applied to most ORD information.\nThey are defined as an object that may have arbitrary keys.\nThe value of a key is an array of strings.\n\nLabels can be used to attach technical information that cannot be expressed natively in ORD.\nAn ORD aggregator should allow to categorize and query information based on the labels provided.\n\nIf multiple parties rely on the existence of certain label information,\nstandardization through ORD SHOULD be preferred.\n\nAll labels attached to a `Package` will be inherited to the resources they contain.\nDuplicate labels will be merged by the ORD aggregator according to the following rules:\n* Values of the same label key will be merged.\n* Duplicate values of the same label key will be removed.",
|
|
6172
|
+
"description": "Generic key-value labels that can be applied to most ORD information.\nThey are defined as an object that may have arbitrary keys.\nThe value of a key is an array of strings.\n\nLabels can be used to attach technical information that cannot be expressed natively in ORD.\nAn ORD aggregator should allow to categorize and query information based on the labels provided.\n\nTo learn more about the concept, see [Labels](../concepts/grouping-and-bundling#labels).\n\nIf multiple parties rely on the existence of certain label information,\nstandardization through ORD SHOULD be preferred.\n\nAll labels attached to a `Package` will be inherited to the resources they contain.\nDuplicate labels will be merged by the ORD aggregator according to the following rules:\n* Values of the same label key will be merged.\n* Duplicate values of the same label key will be removed.",
|
|
5893
6173
|
"x-ums-type": "custom",
|
|
5894
6174
|
"patternProperties": {
|
|
5895
6175
|
"^[a-zA-Z0-9-_.]*$": {
|
|
@@ -5937,10 +6217,7 @@
|
|
|
5937
6217
|
"description": {
|
|
5938
6218
|
"type": "string",
|
|
5939
6219
|
"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
|
-
]
|
|
6220
|
+
"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
6221
|
},
|
|
5945
6222
|
"labels": {
|
|
5946
6223
|
"$ref": "#/definitions/Labels"
|
|
@@ -6022,10 +6299,7 @@
|
|
|
6022
6299
|
"description": {
|
|
6023
6300
|
"type": "string",
|
|
6024
6301
|
"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
|
-
]
|
|
6302
|
+
"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
6303
|
},
|
|
6030
6304
|
"labels": {
|
|
6031
6305
|
"$ref": "#/definitions/Labels"
|
|
@@ -6133,6 +6407,8 @@
|
|
|
6133
6407
|
"title": "Entity Type Mapping",
|
|
6134
6408
|
"type": "object",
|
|
6135
6409
|
"x-introduced-in-version": "1.6.0",
|
|
6410
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6411
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6136
6412
|
"x-ums-type": "custom",
|
|
6137
6413
|
"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
6414
|
"properties": {
|
|
@@ -6238,6 +6514,8 @@
|
|
|
6238
6514
|
"ApiModelSelectorOData": {
|
|
6239
6515
|
"title": "Api Model Selector (Odata)",
|
|
6240
6516
|
"x-introduced-in-version": "1.6.0",
|
|
6517
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6518
|
+
"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
6519
|
"x-ums-type": "custom",
|
|
6242
6520
|
"type": "object",
|
|
6243
6521
|
"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 +6551,8 @@
|
|
|
6273
6551
|
"ApiModelSelectorJsonPointer": {
|
|
6274
6552
|
"title": "Api Model Selector (Json Pointer)",
|
|
6275
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.\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
6556
|
"x-ums-type": "custom",
|
|
6277
6557
|
"type": "object",
|
|
6278
6558
|
"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 +6615,8 @@
|
|
|
6335
6615
|
"EntityTypeOrdIdTarget": {
|
|
6336
6616
|
"title": "Entity Type Target (ORD ID)",
|
|
6337
6617
|
"x-introduced-in-version": "1.6.0",
|
|
6618
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6619
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6338
6620
|
"x-ums-type": "custom",
|
|
6339
6621
|
"type": "object",
|
|
6340
6622
|
"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 +6644,8 @@
|
|
|
6362
6644
|
"type": "object",
|
|
6363
6645
|
"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
6646
|
"x-introduced-in-version": "1.6.0",
|
|
6647
|
+
"x-deprecated-in-version": "1.11.0",
|
|
6648
|
+
"x-deprecation-text": "Use the simplified `relatedEntityTypes` instead.",
|
|
6365
6649
|
"x-ums-type": "custom",
|
|
6366
6650
|
"properties": {
|
|
6367
6651
|
"correlationId": {
|
|
@@ -6399,10 +6683,15 @@
|
|
|
6399
6683
|
},
|
|
6400
6684
|
"relationType": {
|
|
6401
6685
|
"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\".",
|
|
6686
|
+
"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
6687
|
"x-introduced-in-version": "1.12.0",
|
|
6404
6688
|
"x-feature-status": "beta",
|
|
6405
|
-
"
|
|
6689
|
+
"anyOf": [
|
|
6690
|
+
{
|
|
6691
|
+
"type": "string",
|
|
6692
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6693
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6694
|
+
},
|
|
6406
6695
|
{
|
|
6407
6696
|
"const": "part-of",
|
|
6408
6697
|
"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 +6702,125 @@
|
|
|
6413
6702
|
}
|
|
6414
6703
|
],
|
|
6415
6704
|
"examples": [
|
|
6416
|
-
"can-share-identity"
|
|
6705
|
+
"can-share-identity",
|
|
6706
|
+
"foo.bar:relationName"
|
|
6707
|
+
]
|
|
6708
|
+
}
|
|
6709
|
+
},
|
|
6710
|
+
"required": [
|
|
6711
|
+
"ordId"
|
|
6712
|
+
],
|
|
6713
|
+
"additionalProperties": false
|
|
6714
|
+
},
|
|
6715
|
+
"RelatedApiResource": {
|
|
6716
|
+
"title": "Related API Resource",
|
|
6717
|
+
"x-introduced-in-version": "1.14.2",
|
|
6718
|
+
"x-ums-type": "embedded",
|
|
6719
|
+
"type": "object",
|
|
6720
|
+
"description": "Defines a relation to an API Resource (via its ORD ID).",
|
|
6721
|
+
"properties": {
|
|
6722
|
+
"ordId": {
|
|
6723
|
+
"type": "string",
|
|
6724
|
+
"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.",
|
|
6725
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6726
|
+
"maxLength": 255,
|
|
6727
|
+
"examples": [
|
|
6728
|
+
"sap.s4:apiResource:API_BUSINESS_PARTNER:v1"
|
|
6729
|
+
],
|
|
6730
|
+
"x-association-target": [
|
|
6731
|
+
"#/definitions/ApiResource/ordId"
|
|
6732
|
+
]
|
|
6733
|
+
},
|
|
6734
|
+
"relationType": {
|
|
6735
|
+
"type": "string",
|
|
6736
|
+
"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\").",
|
|
6737
|
+
"anyOf": [
|
|
6738
|
+
{
|
|
6739
|
+
"type": "string",
|
|
6740
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6741
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6742
|
+
}
|
|
6743
|
+
],
|
|
6744
|
+
"examples": [
|
|
6745
|
+
"foo.bar:relationName"
|
|
6746
|
+
]
|
|
6747
|
+
}
|
|
6748
|
+
},
|
|
6749
|
+
"required": [
|
|
6750
|
+
"ordId"
|
|
6751
|
+
],
|
|
6752
|
+
"additionalProperties": false
|
|
6753
|
+
},
|
|
6754
|
+
"RelatedEventResource": {
|
|
6755
|
+
"title": "Related Event Resource",
|
|
6756
|
+
"x-introduced-in-version": "1.14.2",
|
|
6757
|
+
"x-ums-type": "embedded",
|
|
6758
|
+
"type": "object",
|
|
6759
|
+
"description": "Defines a relation to an Event Resource (via its ORD ID).",
|
|
6760
|
+
"properties": {
|
|
6761
|
+
"ordId": {
|
|
6762
|
+
"type": "string",
|
|
6763
|
+
"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.",
|
|
6764
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(eventResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6765
|
+
"maxLength": 255,
|
|
6766
|
+
"examples": [
|
|
6767
|
+
"sap.s4:eventResource:BusinessPartnerEvents:v1"
|
|
6768
|
+
],
|
|
6769
|
+
"x-association-target": [
|
|
6770
|
+
"#/definitions/EventResource/ordId"
|
|
6771
|
+
]
|
|
6772
|
+
},
|
|
6773
|
+
"relationType": {
|
|
6774
|
+
"type": "string",
|
|
6775
|
+
"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\").",
|
|
6776
|
+
"anyOf": [
|
|
6777
|
+
{
|
|
6778
|
+
"type": "string",
|
|
6779
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6780
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6781
|
+
}
|
|
6782
|
+
],
|
|
6783
|
+
"examples": [
|
|
6784
|
+
"foo.bar:relationName"
|
|
6785
|
+
]
|
|
6786
|
+
}
|
|
6787
|
+
},
|
|
6788
|
+
"required": [
|
|
6789
|
+
"ordId"
|
|
6790
|
+
],
|
|
6791
|
+
"additionalProperties": false
|
|
6792
|
+
},
|
|
6793
|
+
"RelatedCapability": {
|
|
6794
|
+
"title": "Related Capability",
|
|
6795
|
+
"x-introduced-in-version": "1.14.2",
|
|
6796
|
+
"x-ums-type": "embedded",
|
|
6797
|
+
"type": "object",
|
|
6798
|
+
"description": "Defines a relation to another Capability (via its ORD ID).",
|
|
6799
|
+
"properties": {
|
|
6800
|
+
"ordId": {
|
|
6801
|
+
"type": "string",
|
|
6802
|
+
"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.",
|
|
6803
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(capability):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6804
|
+
"maxLength": 255,
|
|
6805
|
+
"examples": [
|
|
6806
|
+
"sap.foo:capability:fieldExtensibility:v1"
|
|
6807
|
+
],
|
|
6808
|
+
"x-association-target": [
|
|
6809
|
+
"#/definitions/Capability/ordId"
|
|
6810
|
+
]
|
|
6811
|
+
},
|
|
6812
|
+
"relationType": {
|
|
6813
|
+
"type": "string",
|
|
6814
|
+
"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\").",
|
|
6815
|
+
"anyOf": [
|
|
6816
|
+
{
|
|
6817
|
+
"type": "string",
|
|
6818
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6819
|
+
"description": "Any valid [Concept ID](../index.md#concept-id)."
|
|
6820
|
+
}
|
|
6821
|
+
],
|
|
6822
|
+
"examples": [
|
|
6823
|
+
"foo.bar:relationName"
|
|
6417
6824
|
]
|
|
6418
6825
|
}
|
|
6419
6826
|
},
|
|
@@ -6509,10 +6916,7 @@
|
|
|
6509
6916
|
"description": {
|
|
6510
6917
|
"type": "string",
|
|
6511
6918
|
"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
|
-
]
|
|
6919
|
+
"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
6920
|
}
|
|
6517
6921
|
},
|
|
6518
6922
|
"required": [
|
|
@@ -6641,9 +7045,14 @@
|
|
|
6641
7045
|
"type": "string",
|
|
6642
7046
|
"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
7047
|
"oneOf": [
|
|
7048
|
+
{
|
|
7049
|
+
"const": "development",
|
|
7050
|
+
"x-introduced-in-version": "1.14.2",
|
|
7051
|
+
"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."
|
|
7052
|
+
},
|
|
6644
7053
|
{
|
|
6645
7054
|
"const": "beta",
|
|
6646
|
-
"description": "The API contract has no stability guarantees
|
|
7055
|
+
"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
7056
|
},
|
|
6648
7057
|
{
|
|
6649
7058
|
"const": "active",
|