@open-resource-discovery/specification 1.13.0 → 1.14.0
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.
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
4
4
|
"$id": "https://open-resource-discovery.org/spec-v1/interfaces/Document.schema.json#",
|
|
5
5
|
"title": "Ord Document",
|
|
6
|
+
"x-ums-type": "ignore",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
9
|
"$schema": {
|
|
@@ -36,10 +37,11 @@
|
|
|
36
37
|
"1.10",
|
|
37
38
|
"1.11",
|
|
38
39
|
"1.12",
|
|
39
|
-
"1.13"
|
|
40
|
+
"1.13",
|
|
41
|
+
"1.14"
|
|
40
42
|
],
|
|
41
43
|
"examples": [
|
|
42
|
-
"1.
|
|
44
|
+
"1.14"
|
|
43
45
|
]
|
|
44
46
|
},
|
|
45
47
|
"description": {
|
|
@@ -177,6 +179,15 @@
|
|
|
177
179
|
"$ref": "#/definitions/DataProduct"
|
|
178
180
|
}
|
|
179
181
|
},
|
|
182
|
+
"agents": {
|
|
183
|
+
"type": "array",
|
|
184
|
+
"description": "Array of all AI Agents that are described in this ORD document.",
|
|
185
|
+
"x-introduced-in-version": "1.14.0",
|
|
186
|
+
"x-feature-status": "beta",
|
|
187
|
+
"items": {
|
|
188
|
+
"$ref": "#/definitions/Agent"
|
|
189
|
+
}
|
|
190
|
+
},
|
|
180
191
|
"integrationDependencies": {
|
|
181
192
|
"type": "array",
|
|
182
193
|
"description": "Array of all integration dependencies that are described in this ORD document.",
|
|
@@ -248,6 +259,7 @@
|
|
|
248
259
|
"Package": {
|
|
249
260
|
"type": "object",
|
|
250
261
|
"title": "Package",
|
|
262
|
+
"x-ums-type": "root",
|
|
251
263
|
"description": "A [**Package**](../concepts/grouping-and-bundling#package) organizes a set of related resources together, by publishing and catalog presentation concerns.\n\nThe Package can also be used to indicate which products or vendors provided the packaged resources.\nFor partner or customer content, the Package can indicate this via the `vendor` and `partOfProducts` assignments.\nIn any case, the Package `ordID` namespace MUST reflect the namespace of the providing application (which hosts the resource), not the resource definition owner, which could be a customer or partner.\n\nA Package SHOULD contain at least one resource. Avoid empty Packages.\n\nThe Package assignment of a resource MAY change, so consumers MUST not rely on this to be stable.\n\nA Package does not have a `visibility` property.\nWhether it is displayed is decided by the fact, whether it contains any visible resources according to the visibility role of the aggregator.\n\nTo learn more about the concept and further guidance, see [Package](../concepts/grouping-and-bundling#package).",
|
|
252
264
|
"properties": {
|
|
253
265
|
"ordId": {
|
|
@@ -660,6 +672,7 @@
|
|
|
660
672
|
"ConsumptionBundle": {
|
|
661
673
|
"type": "object",
|
|
662
674
|
"title": "Consumption Bundle",
|
|
675
|
+
"x-ums-type": "root",
|
|
663
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 correctly this correctly, see [Consumption Bundle details](../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).",
|
|
664
677
|
"properties": {
|
|
665
678
|
"ordId": {
|
|
@@ -808,6 +821,7 @@
|
|
|
808
821
|
"ConsumptionBundleReference": {
|
|
809
822
|
"type": "object",
|
|
810
823
|
"title": "Consumption Bundle Reference",
|
|
824
|
+
"x-ums-type": "embedded",
|
|
811
825
|
"description": "Reference to a Consumption Bundle.\n\nThis is a complex object to allow additional properties / selections to be attached.",
|
|
812
826
|
"properties": {
|
|
813
827
|
"ordId": {
|
|
@@ -836,6 +850,7 @@
|
|
|
836
850
|
"ApiResource": {
|
|
837
851
|
"type": "object",
|
|
838
852
|
"title": "Api Resource",
|
|
853
|
+
"x-ums-type": "root",
|
|
839
854
|
"description": "The API Resource provides a high-level description of an exposed API.\nYou can find more information, such as the API resource definitions, in the links in the table below.\n\nAn API Resource bundles multiple endpoints and resources together.\nThey share the same API namespace and lifecycle (API major version).\nHowever, the exact granularity of this is up to the implementer of the API.\nAs a consequence, an API resource MUST NOT bundle together endpoints from different API versions or namespaces.\n\nA common practice is to bundle endpoints that are based on the same domain or Business Object.\n\nPlease note that APIs can be described, but still be [`disabled`](#api-resource_disabled).\n\nIf the API is not created or owned by the user of the system or by third parties (like partners), it MUST be assigned to dedicated [Packages](#package) that state this the ownership via the `vendor` property.",
|
|
840
855
|
"properties": {
|
|
841
856
|
"ordId": {
|
|
@@ -981,6 +996,13 @@
|
|
|
981
996
|
"2022-12-19T15:47:04+00:00"
|
|
982
997
|
]
|
|
983
998
|
},
|
|
999
|
+
"abstract": {
|
|
1000
|
+
"type": "boolean",
|
|
1001
|
+
"default": false,
|
|
1002
|
+
"x-introduced-in-version": "1.13.0",
|
|
1003
|
+
"x-feature-status": "beta",
|
|
1004
|
+
"description": "Indicates that the resource serves as interface only and cannot be called directly, similar to the abstract keyword in programming languages like Java.\n\nAbstract resources define contracts that other resources can declare compatibility with through the `compatibleWith` property.\n\nMore details can be found on the [Compatibility](../concepts/compatibility) concept page."
|
|
1005
|
+
},
|
|
984
1006
|
"visibility": {
|
|
985
1007
|
"type": "string",
|
|
986
1008
|
"description": "The visibility states who is allowed to \"see\" the described resource or capability.",
|
|
@@ -1227,15 +1249,19 @@
|
|
|
1227
1249
|
]
|
|
1228
1250
|
},
|
|
1229
1251
|
"compatibleWith": {
|
|
1252
|
+
"x-introduced-in-version": "1.13.0",
|
|
1253
|
+
"x-feature-status": "beta",
|
|
1230
1254
|
"type": "array",
|
|
1231
|
-
"description": "A reference to the interface (API contract) that this API implements.\nServes as a declaration of compatible implementation of API contract, effectively functioning as an \"implementationOf\" relationship.\n\nMUST be a valid reference to an (usually external) [API Resource](#api-resource) ORD ID.\n\nAll APIs that share the same `compatibleWith` value MAY be treated the same or similar by a consumer client.",
|
|
1255
|
+
"description": "A reference to the interface (API contract) and its maximum version that this API implements. Even if the interface contract evolves compatible, this resource will not be compatible with versions beyond the specified one.\n\nServes as a declaration of compatible implementation of API contract, effectively functioning as an \"implementationOf\" relationship. The data that compatible APIs return follow the same schema, but itself can be different.\nThis means that if one API is returning 1 record for a dedicated request, a compatible API could return multiple and different records, as long as they adhere to the same schema.\n\nMUST be a valid reference to an (usually external) [API Resource](#api-resource) ORD ID.\n\nAll APIs that share the same `compatibleWith` value MAY be treated the same or similar by a consumer client.\n\nMore details can be found on the [Compatibility](../concepts/compatibility) concept page.",
|
|
1232
1256
|
"items": {
|
|
1233
|
-
"
|
|
1234
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$"
|
|
1257
|
+
"$ref": "#/definitions/ApiCompatibility"
|
|
1235
1258
|
},
|
|
1236
1259
|
"examples": [
|
|
1237
1260
|
[
|
|
1238
|
-
|
|
1261
|
+
{
|
|
1262
|
+
"ordId": "sap.s4com:apiResource:SomeSharedContract:v1",
|
|
1263
|
+
"maxVersion": "1.2"
|
|
1264
|
+
}
|
|
1239
1265
|
]
|
|
1240
1266
|
]
|
|
1241
1267
|
},
|
|
@@ -1652,6 +1678,7 @@
|
|
|
1652
1678
|
"EventResource": {
|
|
1653
1679
|
"type": "object",
|
|
1654
1680
|
"title": "Event Resource",
|
|
1681
|
+
"x-ums-type": "root",
|
|
1655
1682
|
"description": "The event resource provides a high-level description of a collection of related Events. More detailed information, such as the event resource definitions, are provided in links in the table below.\nWhich events are considered \"related\" is up to the implementer. A common practice is to bundle events that are based on the same resource/Business Object. It is also an option to bundle all available events into a single event resource/event catalog.\nPlease note that event resources can be described, but still be [`disabled`](#event-resource_disabled).\nIf the event resource is not created or owned by the user / customer of the system or by partners / third parties, it MUST be assigned to dedicated [Packages](#package) that state this the ownership via the `vendor` property.",
|
|
1656
1683
|
"properties": {
|
|
1657
1684
|
"ordId": {
|
|
@@ -1799,6 +1826,13 @@
|
|
|
1799
1826
|
"2022-12-19T15:47:04+00:00"
|
|
1800
1827
|
]
|
|
1801
1828
|
},
|
|
1829
|
+
"abstract": {
|
|
1830
|
+
"type": "boolean",
|
|
1831
|
+
"default": false,
|
|
1832
|
+
"x-introduced-in-version": "1.13.0",
|
|
1833
|
+
"x-feature-status": "beta",
|
|
1834
|
+
"description": "Indicates that the resource serves as interface only and cannot be called directly, similar to the abstract keyword in programming languages like Java.\n\nAbstract resources define contracts that other resources can declare compatibility with through the `compatibleWith` property.\n\nMore details can be found on the [Compatibility](../concepts/compatibility) concept page."
|
|
1835
|
+
},
|
|
1802
1836
|
"visibility": {
|
|
1803
1837
|
"type": "string",
|
|
1804
1838
|
"description": "The visibility states who is allowed to \"see\" the described resource or capability.",
|
|
@@ -1947,15 +1981,19 @@
|
|
|
1947
1981
|
]
|
|
1948
1982
|
},
|
|
1949
1983
|
"compatibleWith": {
|
|
1984
|
+
"x-introduced-in-version": "1.13.0",
|
|
1985
|
+
"x-feature-status": "beta",
|
|
1950
1986
|
"type": "array",
|
|
1951
|
-
"description": "
|
|
1987
|
+
"description": "A reference to the interface (event contract) and its maximum version that this event implements. Even if the interface contract evolves compatible, this resource will not be compatible with versions beyond the specified one.\n\nServes as a declaration of compatible implementation of event contract, effectively functioning as an \"implementationOf\" relationship. The data that compatible events return follow the same schema, but itself can be different.\nThis means that if one event is returning 1 record for a dedicated request, a compatible event could return multiple and different records, as long as they adhere to the same schema.\n\nAll events that share the same `compatibleWith` value MAY be treated the same or similar by a consumer client.\n\nMore details can be found on the [Compatibility](../concepts/compatibility) concept page.",
|
|
1952
1988
|
"items": {
|
|
1953
|
-
"
|
|
1954
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(eventResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$"
|
|
1989
|
+
"$ref": "#/definitions/EventCompatibility"
|
|
1955
1990
|
},
|
|
1956
1991
|
"examples": [
|
|
1957
1992
|
[
|
|
1958
|
-
|
|
1993
|
+
{
|
|
1994
|
+
"ordId": "sap.s4:eventResource:BillofMaterialEvents:v1",
|
|
1995
|
+
"maxVersion": "1.2"
|
|
1996
|
+
}
|
|
1959
1997
|
]
|
|
1960
1998
|
]
|
|
1961
1999
|
},
|
|
@@ -2320,6 +2358,7 @@
|
|
|
2320
2358
|
"EntityType": {
|
|
2321
2359
|
"type": "object",
|
|
2322
2360
|
"title": "Entity Type",
|
|
2361
|
+
"x-ums-type": "root",
|
|
2323
2362
|
"description": "An [**Entity Type**](../concepts/grouping-and-bundling#entity-type) describes either a business concept / term or an underlying conceptual model.\nThe same entity type can be exposed through one or multiple API and events resources.\n\nTo learn more about the concept, see [Entity Type](../concepts/grouping-and-bundling#entity-type).",
|
|
2324
2363
|
"x-introduced-in-version": "1.8.0",
|
|
2325
2364
|
"properties": {
|
|
@@ -2686,6 +2725,7 @@
|
|
|
2686
2725
|
"DataProduct": {
|
|
2687
2726
|
"type": "object",
|
|
2688
2727
|
"title": "Data Product",
|
|
2728
|
+
"x-ums-type": "root",
|
|
2689
2729
|
"x-introduced-in-version": "1.8.0",
|
|
2690
2730
|
"description": "A [Data Product](../concepts/data-product) is a data set exposed for consumption outside the boundaries of the producing application via APIs and described by high quality metadata that can be accessed through the [ORD Aggregator](../../spec-v1/#ord-aggregator).\n\nPlease note that this concept is in beta, see [Data Product - Current Status](../concepts/data-product#current-status).",
|
|
2691
2731
|
"properties": {
|
|
@@ -2857,6 +2897,13 @@
|
|
|
2857
2897
|
"default": false,
|
|
2858
2898
|
"description": "Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.\nThis can happen either because it has not been setup for use or disabled by an admin / user.\n\nIf the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance-aware perspective.\n\nThis property can only reflect the knowledge of the described system instance itself.\nOutside factors for availability can't need to be considered (e.g. network connectivity, middlewares).\n\nA disabled resource MAY skip describing its resource definitions.\n"
|
|
2859
2899
|
},
|
|
2900
|
+
"abstract": {
|
|
2901
|
+
"type": "boolean",
|
|
2902
|
+
"default": false,
|
|
2903
|
+
"x-introduced-in-version": "1.13.0",
|
|
2904
|
+
"x-feature-status": "beta",
|
|
2905
|
+
"description": "Indicates that the data product serves as interface only. All output ports MUST be marked as abstract.\n\nImplementations of this data product MUST declare compatible with on their specific output port resources as consumption of data products happens through the output ports."
|
|
2906
|
+
},
|
|
2860
2907
|
"minSystemVersion": {
|
|
2861
2908
|
"type": "string",
|
|
2862
2909
|
"description": "The resource has been introduced in the given [system version](../index.md#system-version).\nThis implies that the resource is only available if the system instance is of at least that system version.\n\nIt MUST follow the [Semantic Versioning 2.0.0](https://semver.org/) standard.",
|
|
@@ -3395,6 +3442,7 @@
|
|
|
3395
3442
|
"DataProductInputPort": {
|
|
3396
3443
|
"type": "object",
|
|
3397
3444
|
"title": "Data Product Input Port",
|
|
3445
|
+
"x-ums-type": "embedded",
|
|
3398
3446
|
"description": "An input port of a data product states where it retrieves its data inputs from.\n\nIt is described as via an ORD Integration Dependency.",
|
|
3399
3447
|
"properties": {
|
|
3400
3448
|
"ordId": {
|
|
@@ -3418,6 +3466,7 @@
|
|
|
3418
3466
|
"DataProductOutputPort": {
|
|
3419
3467
|
"type": "object",
|
|
3420
3468
|
"title": "Data Product Output Port",
|
|
3469
|
+
"x-ums-type": "embedded",
|
|
3421
3470
|
"description": "A data product output port references the APIs or Events that can be used to access the data-set.\nIt MAY provide full access to the complete data set, but can also just expose a subset of it - if other output ports cover the missing parts.\n\nReferenced API or Event ORD resources don't need to be provided within the same ORD document.\nIf a data product is built against a specific API contract of another application or data product, this API resource should be referred to.\nIn this case the other application is responsible for the lifecycle of the API contract and will update its ORD description independently.",
|
|
3422
3471
|
"properties": {
|
|
3423
3472
|
"ordId": {
|
|
@@ -3444,6 +3493,7 @@
|
|
|
3444
3493
|
"type": "object",
|
|
3445
3494
|
"title": "Api Resource Definition",
|
|
3446
3495
|
"description": "Link and categorization of a machine-readable API definition.\nFor example, OpenAPI definition, OData Metadata, etc.",
|
|
3496
|
+
"x-ums-type": "custom",
|
|
3447
3497
|
"properties": {
|
|
3448
3498
|
"type": {
|
|
3449
3499
|
"description": "Type of the API Resource Definition\nIf \"custom\" is chosen, a customType MUST be provided",
|
|
@@ -3606,6 +3656,7 @@
|
|
|
3606
3656
|
"EventResourceDefinition": {
|
|
3607
3657
|
"type": "object",
|
|
3608
3658
|
"title": "Event Resource Definition",
|
|
3659
|
+
"x-ums-type": "custom",
|
|
3609
3660
|
"description": "Link and categorization of a machine-readable API definition.\nFor example, AsyncAPI or OpenAPI with callbacks, etc.",
|
|
3610
3661
|
"properties": {
|
|
3611
3662
|
"type": {
|
|
@@ -3718,126 +3769,21 @@
|
|
|
3718
3769
|
"url"
|
|
3719
3770
|
]
|
|
3720
3771
|
},
|
|
3721
|
-
"
|
|
3722
|
-
"type": "object",
|
|
3723
|
-
"title": "Product",
|
|
3724
|
-
"description": "A **product** in ORD is understood as a commercial product or service.\n\nIt is a high-level entity for structuring the software portfolio from a sales / software logistics perspective.\nWhile **system type** is a technical concept, **product** covers the commercial 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.",
|
|
3725
|
-
"properties": {
|
|
3726
|
-
"ordId": {
|
|
3727
|
-
"type": "string",
|
|
3728
|
-
"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.",
|
|
3729
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
|
|
3730
|
-
"maxLength": 255,
|
|
3731
|
-
"examples": [
|
|
3732
|
-
"sap:product:S4HANA_OD:"
|
|
3733
|
-
]
|
|
3734
|
-
},
|
|
3735
|
-
"correlationIds": {
|
|
3736
|
-
"type": "array",
|
|
3737
|
-
"description": "Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).\n\nThey express an \"identity\" / \"equals\" / \"mappable\" relationship to the target ID.\n\nIf a \"part of\" relationship needs to be expressed, use the `partOfGroups` assignment instead.\n\nMUST be a valid [Correlation ID](../index.md#correlation-id).",
|
|
3738
|
-
"items": {
|
|
3739
|
-
"type": "string",
|
|
3740
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
3741
|
-
"maxLength": 255
|
|
3742
|
-
},
|
|
3743
|
-
"examples": [
|
|
3744
|
-
[
|
|
3745
|
-
"sap.xref:product:ABC"
|
|
3746
|
-
]
|
|
3747
|
-
]
|
|
3748
|
-
},
|
|
3749
|
-
"title": {
|
|
3750
|
-
"type": "string",
|
|
3751
|
-
"description": "Human-readable title.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
3752
|
-
"minLength": 1,
|
|
3753
|
-
"maxLength": 255,
|
|
3754
|
-
"examples": [
|
|
3755
|
-
"SAP S/4HANA Cloud"
|
|
3756
|
-
]
|
|
3757
|
-
},
|
|
3758
|
-
"shortDescription": {
|
|
3759
|
-
"type": "string",
|
|
3760
|
-
"description": "Plain text short description.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
3761
|
-
"minLength": 1,
|
|
3762
|
-
"maxLength": 255,
|
|
3763
|
-
"examples": [
|
|
3764
|
-
"The next generation digital core designed to help you run simple in a digital economy."
|
|
3765
|
-
]
|
|
3766
|
-
},
|
|
3767
|
-
"description": {
|
|
3768
|
-
"type": "string",
|
|
3769
|
-
"minLength": 1,
|
|
3770
|
-
"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.",
|
|
3771
|
-
"examples": []
|
|
3772
|
-
},
|
|
3773
|
-
"vendor": {
|
|
3774
|
-
"type": "string",
|
|
3775
|
-
"description": "Vendor / organization that is responsible for the Product.\n\nMUST be a valid reference to a [Vendor](#vendor) ORD ID.",
|
|
3776
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(vendor):([a-zA-Z0-9._\\-]+):()$",
|
|
3777
|
-
"maxLength": 256,
|
|
3778
|
-
"x-association-target": [
|
|
3779
|
-
"#/definitions/Vendor/ordId"
|
|
3780
|
-
],
|
|
3781
|
-
"examples": [
|
|
3782
|
-
"sap:vendor:SAP:",
|
|
3783
|
-
"customer:vendor:Customer:",
|
|
3784
|
-
"microsoft:vendor:Microsoft:"
|
|
3785
|
-
]
|
|
3786
|
-
},
|
|
3787
|
-
"parent": {
|
|
3788
|
-
"type": "string",
|
|
3789
|
-
"description": "Optional product parent ORD ID, if a hierarchical product structure needs to be expressed.\n\nMUST be a valid reference to a [Product](#product) ORD ID.",
|
|
3790
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
|
|
3791
|
-
"x-association-target": [
|
|
3792
|
-
"#/definitions/Product/ordId"
|
|
3793
|
-
],
|
|
3794
|
-
"examples": [
|
|
3795
|
-
"sap:product:S4HANA_OD:"
|
|
3796
|
-
]
|
|
3797
|
-
},
|
|
3798
|
-
"tags": {
|
|
3799
|
-
"type": "array",
|
|
3800
|
-
"items": {
|
|
3801
|
-
"type": "string",
|
|
3802
|
-
"pattern": "^[a-zA-Z0-9-_.\\/ ]*$",
|
|
3803
|
-
"minLength": 1
|
|
3804
|
-
},
|
|
3805
|
-
"description": "List of free text style tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\nTags that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
3806
|
-
"examples": [
|
|
3807
|
-
[
|
|
3808
|
-
"storage",
|
|
3809
|
-
"high-availability"
|
|
3810
|
-
]
|
|
3811
|
-
]
|
|
3812
|
-
},
|
|
3813
|
-
"labels": {
|
|
3814
|
-
"$ref": "#/definitions/Labels"
|
|
3815
|
-
},
|
|
3816
|
-
"documentationLabels": {
|
|
3817
|
-
"$ref": "#/definitions/DocumentationLabels"
|
|
3818
|
-
}
|
|
3819
|
-
},
|
|
3820
|
-
"additionalProperties": false,
|
|
3821
|
-
"required": [
|
|
3822
|
-
"ordId",
|
|
3823
|
-
"title",
|
|
3824
|
-
"shortDescription",
|
|
3825
|
-
"vendor"
|
|
3826
|
-
]
|
|
3827
|
-
},
|
|
3828
|
-
"Capability": {
|
|
3772
|
+
"Agent": {
|
|
3829
3773
|
"type": "object",
|
|
3830
|
-
"title": "
|
|
3831
|
-
"x-
|
|
3832
|
-
"
|
|
3774
|
+
"title": "Agent",
|
|
3775
|
+
"x-ums-type": "root",
|
|
3776
|
+
"x-introduced-in-version": "1.14.0",
|
|
3777
|
+
"x-feature-status": "beta",
|
|
3778
|
+
"description": "An **Agent** provides a high-level description of an AI-powered autonomous system that can perform tasks, make decisions, and interact with users or other systems to achieve specific business goals.\n\nAn Agent can relate to specific entity types it works with, declare integration dependencies on external systems it requires, and expose its capabilities through APIs using protocols like A2A (Agent-to-Agent).\n\nAgents enable intelligent automation and decision-making within business processes by providing semantic understanding and context-aware capabilities beyond traditional API-based integrations.\n\nFor more details, see [AI Agents and Protocols](../concepts/ai-agents-and-protocols.md).",
|
|
3833
3779
|
"properties": {
|
|
3834
3780
|
"ordId": {
|
|
3835
3781
|
"type": "string",
|
|
3836
3782
|
"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.",
|
|
3837
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(
|
|
3783
|
+
"pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):(agent):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3838
3784
|
"maxLength": 255,
|
|
3839
3785
|
"examples": [
|
|
3840
|
-
"sap.foo.bar:
|
|
3786
|
+
"sap.foo.bar:agent:disputeAgent:v1"
|
|
3841
3787
|
]
|
|
3842
3788
|
},
|
|
3843
3789
|
"localId": {
|
|
@@ -3864,44 +3810,13 @@
|
|
|
3864
3810
|
]
|
|
3865
3811
|
]
|
|
3866
3812
|
},
|
|
3867
|
-
"type": {
|
|
3868
|
-
"description": "Type of the Capability",
|
|
3869
|
-
"type": "string",
|
|
3870
|
-
"anyOf": [
|
|
3871
|
-
{
|
|
3872
|
-
"type": "string",
|
|
3873
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3874
|
-
"description": "Any valid [Specification ID](../index.md#specification-id)."
|
|
3875
|
-
},
|
|
3876
|
-
{
|
|
3877
|
-
"const": "sap.mdo:mdi-capability:v1",
|
|
3878
|
-
"description": "Capability for SAP Master Data Integration (MDI).\n\nFor the capability definitions: `type` MUST ONLY be set to `sap.mdo:mdi-capability-definition:v1`."
|
|
3879
|
-
},
|
|
3880
|
-
{
|
|
3881
|
-
"const": "custom",
|
|
3882
|
-
"description": "If chosen, `customType` MUST be provided."
|
|
3883
|
-
}
|
|
3884
|
-
],
|
|
3885
|
-
"examples": [
|
|
3886
|
-
"custom"
|
|
3887
|
-
]
|
|
3888
|
-
},
|
|
3889
|
-
"customType": {
|
|
3890
|
-
"type": "string",
|
|
3891
|
-
"description": "If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.\n\nMUST be a valid [Specification ID](../index.md#specification-id).\n\nMUST only be provided if `type` is set to `custom`.",
|
|
3892
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3893
|
-
"maxLength": 255,
|
|
3894
|
-
"examples": [
|
|
3895
|
-
"sap:custom-definition-format:v1"
|
|
3896
|
-
]
|
|
3897
|
-
},
|
|
3898
3813
|
"title": {
|
|
3899
3814
|
"type": "string",
|
|
3900
3815
|
"description": "Human-readable title.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
3901
3816
|
"minLength": 1,
|
|
3902
3817
|
"maxLength": 255,
|
|
3903
3818
|
"examples": [
|
|
3904
|
-
"
|
|
3819
|
+
"Dispute Agent"
|
|
3905
3820
|
]
|
|
3906
3821
|
},
|
|
3907
3822
|
"shortDescription": {
|
|
@@ -4020,59 +3935,735 @@
|
|
|
4020
3935
|
"2024.8.0"
|
|
4021
3936
|
]
|
|
4022
3937
|
},
|
|
4023
|
-
"
|
|
3938
|
+
"partOfProducts": {
|
|
4024
3939
|
"type": "array",
|
|
4025
|
-
"description": "
|
|
3940
|
+
"description": "List of products the resources of the Package are a part of.\n\nMUST be a valid reference to a [Product](#product) ORD ID.\n\n`partOfProducts` that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4026
3941
|
"items": {
|
|
4027
3942
|
"type": "string",
|
|
4028
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(
|
|
3943
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
|
|
3944
|
+
"maxLength": 255,
|
|
4029
3945
|
"x-association-target": [
|
|
4030
|
-
"#/definitions/
|
|
3946
|
+
"#/definitions/Product/ordId"
|
|
4031
3947
|
]
|
|
4032
3948
|
},
|
|
3949
|
+
"minItems": 0,
|
|
4033
3950
|
"examples": [
|
|
4034
3951
|
[
|
|
4035
|
-
"sap
|
|
3952
|
+
"sap:product:S4HANA_OD:"
|
|
4036
3953
|
]
|
|
4037
3954
|
]
|
|
4038
3955
|
},
|
|
4039
|
-
"
|
|
3956
|
+
"responsible": {
|
|
3957
|
+
"type": "string",
|
|
3958
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
3959
|
+
"maxLength": 255,
|
|
3960
|
+
"x-introduced-in-version": "1.8.0",
|
|
3961
|
+
"description": "Contains typically the organization that is responsible in the sense of RACI matrix for this ORD resource. This includes support and feature requests. It is maintained as correlation id to for example support components.",
|
|
3962
|
+
"examples": [
|
|
3963
|
+
"sap:ach:CIC-DP-CO"
|
|
3964
|
+
]
|
|
3965
|
+
},
|
|
3966
|
+
"deprecationDate": {
|
|
3967
|
+
"type": "string",
|
|
3968
|
+
"format": "date-time",
|
|
3969
|
+
"description": "The deprecation date defines when the resource has been set as deprecated.\nThis is not to be confused with the `sunsetDate` which defines when the resource will be actually sunset, aka. decommissioned / removed / archived.\n\nThe date format MUST comply with [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).",
|
|
3970
|
+
"examples": [
|
|
3971
|
+
"2020-12-08T15:47:04+00:00"
|
|
3972
|
+
]
|
|
3973
|
+
},
|
|
3974
|
+
"sunsetDate": {
|
|
3975
|
+
"type": "string",
|
|
3976
|
+
"format": "date-time",
|
|
3977
|
+
"description": "The sunset date defines when the resource is scheduled to be decommissioned / removed / archived.\n\nIf the `releaseStatus` is set to `deprecated`, the `sunsetDate` SHOULD be provided (if already known).\nOnce the sunset date is known and ready to be communicated externally, it MUST be provided here.\n\nThe date format MUST comply with [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).",
|
|
3978
|
+
"examples": [
|
|
3979
|
+
"2022-01-08T15:47:04+00:00"
|
|
3980
|
+
]
|
|
3981
|
+
},
|
|
3982
|
+
"successors": {
|
|
4040
3983
|
"type": "array",
|
|
4041
|
-
"description": "
|
|
3984
|
+
"description": "The successor resource(s).\n\nMUST be a valid reference to an ORD ID.\n\nIf the `releaseStatus` is set to `deprecated`, `successors` MUST be provided if one exists.\nIf `successors` is given, the described resource SHOULD set its `releaseStatus` to `deprecated`.",
|
|
4042
3985
|
"items": {
|
|
4043
|
-
"
|
|
3986
|
+
"type": "string",
|
|
3987
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(agent):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
3988
|
+
"x-association-target": [
|
|
3989
|
+
"#/definitions/Agent/ordId"
|
|
3990
|
+
],
|
|
3991
|
+
"maxLength": 255
|
|
4044
3992
|
}
|
|
4045
3993
|
},
|
|
4046
|
-
"
|
|
3994
|
+
"changelogEntries": {
|
|
4047
3995
|
"type": "array",
|
|
4048
|
-
"description": "
|
|
3996
|
+
"description": "Contains changelog entries that summarize changes with special regards to version and releaseStatus",
|
|
4049
3997
|
"items": {
|
|
4050
|
-
"$ref": "#/definitions/
|
|
3998
|
+
"$ref": "#/definitions/ChangelogEntry"
|
|
4051
3999
|
}
|
|
4052
4000
|
},
|
|
4053
|
-
"
|
|
4001
|
+
"policyLevels": {
|
|
4054
4002
|
"type": "array",
|
|
4003
|
+
"description": "A list of [policy levels](../../spec-extensions/policy-levels/) that the described resources need to be compliant with.\nFor each chosen policy level, additional expectations and validations rules will be applied.\n\nPolicy levels can be defined on ORD Document level, but also be overwritten on an individual package or resource level.\n\nA policy level MUST be a valid [Specification ID](../index.md#specification-id).",
|
|
4004
|
+
"x-introduced-in-version": "1.9.9",
|
|
4055
4005
|
"items": {
|
|
4056
4006
|
"type": "string",
|
|
4057
|
-
"pattern": "^[a-zA-Z0-9
|
|
4058
|
-
"
|
|
4007
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4008
|
+
"maxLength": 255,
|
|
4009
|
+
"examples": [
|
|
4010
|
+
"sap:core:v1"
|
|
4011
|
+
]
|
|
4012
|
+
}
|
|
4013
|
+
},
|
|
4014
|
+
"countries": {
|
|
4015
|
+
"type": "array",
|
|
4016
|
+
"items": {
|
|
4017
|
+
"type": "string",
|
|
4018
|
+
"pattern": "^[A-Z]{2}$"
|
|
4059
4019
|
},
|
|
4060
|
-
"description": "List of
|
|
4020
|
+
"description": "List of countries that the Package resources are applicable to.\n\nMUST be expressed as an array of country codes according to [IES ISO-3166 ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\n\n`countries` that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4061
4021
|
"examples": [
|
|
4062
4022
|
[
|
|
4063
|
-
"
|
|
4064
|
-
"
|
|
4023
|
+
"DE",
|
|
4024
|
+
"US"
|
|
4065
4025
|
]
|
|
4066
4026
|
]
|
|
4067
4027
|
},
|
|
4068
|
-
"
|
|
4069
|
-
"
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4028
|
+
"lineOfBusiness": {
|
|
4029
|
+
"type": "array",
|
|
4030
|
+
"items": {
|
|
4031
|
+
"type": "string",
|
|
4032
|
+
"pattern": "^[a-zA-Z0-9-_.\\/& ]*$",
|
|
4033
|
+
"minLength": 1,
|
|
4034
|
+
"anyOf": [
|
|
4035
|
+
{
|
|
4036
|
+
"type": "string"
|
|
4037
|
+
},
|
|
4038
|
+
{
|
|
4039
|
+
"const": "Asset Management"
|
|
4040
|
+
},
|
|
4041
|
+
{
|
|
4042
|
+
"const": "Commerce"
|
|
4043
|
+
},
|
|
4044
|
+
{
|
|
4045
|
+
"const": "Finance"
|
|
4046
|
+
},
|
|
4047
|
+
{
|
|
4048
|
+
"const": "Human Resources"
|
|
4049
|
+
},
|
|
4050
|
+
{
|
|
4051
|
+
"const": "Manufacturing"
|
|
4052
|
+
},
|
|
4053
|
+
{
|
|
4054
|
+
"const": "Marketing"
|
|
4055
|
+
},
|
|
4056
|
+
{
|
|
4057
|
+
"const": "R&D Engineering"
|
|
4058
|
+
},
|
|
4059
|
+
{
|
|
4060
|
+
"const": "Sales"
|
|
4061
|
+
},
|
|
4062
|
+
{
|
|
4063
|
+
"const": "Service"
|
|
4064
|
+
},
|
|
4065
|
+
{
|
|
4066
|
+
"const": "Sourcing and Procurement"
|
|
4067
|
+
},
|
|
4068
|
+
{
|
|
4069
|
+
"const": "Strategy, Compliance, and Governance"
|
|
4070
|
+
},
|
|
4071
|
+
{
|
|
4072
|
+
"const": "Supply Chain"
|
|
4073
|
+
},
|
|
4074
|
+
{
|
|
4075
|
+
"const": "Sustainability"
|
|
4076
|
+
},
|
|
4077
|
+
{
|
|
4078
|
+
"const": "Metering"
|
|
4079
|
+
},
|
|
4080
|
+
{
|
|
4081
|
+
"const": "Grid Operations and Maintenance"
|
|
4082
|
+
},
|
|
4083
|
+
{
|
|
4084
|
+
"const": "Plant Operations and Maintenance"
|
|
4085
|
+
},
|
|
4086
|
+
{
|
|
4087
|
+
"const": "Maintenance and Engineering"
|
|
4088
|
+
}
|
|
4089
|
+
]
|
|
4090
|
+
},
|
|
4091
|
+
"description": "List of line of business tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\n`lineOfBusiness` that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4092
|
+
"examples": [
|
|
4093
|
+
[
|
|
4094
|
+
"Sales"
|
|
4095
|
+
]
|
|
4096
|
+
]
|
|
4097
|
+
},
|
|
4098
|
+
"industry": {
|
|
4099
|
+
"type": "array",
|
|
4100
|
+
"items": {
|
|
4101
|
+
"type": "string",
|
|
4102
|
+
"pattern": "^[a-zA-Z0-9-_.\\/& ]*$",
|
|
4103
|
+
"minLength": 1,
|
|
4104
|
+
"anyOf": [
|
|
4105
|
+
{
|
|
4106
|
+
"type": "string"
|
|
4107
|
+
},
|
|
4108
|
+
{
|
|
4109
|
+
"const": "Aerospace and Defense"
|
|
4110
|
+
},
|
|
4111
|
+
{
|
|
4112
|
+
"const": "Agribusiness"
|
|
4113
|
+
},
|
|
4114
|
+
{
|
|
4115
|
+
"const": "Automotive"
|
|
4116
|
+
},
|
|
4117
|
+
{
|
|
4118
|
+
"const": "Banking"
|
|
4119
|
+
},
|
|
4120
|
+
{
|
|
4121
|
+
"const": "Chemicals"
|
|
4122
|
+
},
|
|
4123
|
+
{
|
|
4124
|
+
"const": "Consumer Industries"
|
|
4125
|
+
},
|
|
4126
|
+
{
|
|
4127
|
+
"const": "Consumer Products"
|
|
4128
|
+
},
|
|
4129
|
+
{
|
|
4130
|
+
"const": "Defense and Security"
|
|
4131
|
+
},
|
|
4132
|
+
{
|
|
4133
|
+
"const": "Discrete Industries"
|
|
4134
|
+
},
|
|
4135
|
+
{
|
|
4136
|
+
"const": "Energy and Natural Resources"
|
|
4137
|
+
},
|
|
4138
|
+
{
|
|
4139
|
+
"const": "Engineering Construction and Operations"
|
|
4140
|
+
},
|
|
4141
|
+
{
|
|
4142
|
+
"const": "Financial Services"
|
|
4143
|
+
},
|
|
4144
|
+
{
|
|
4145
|
+
"const": "Future Cities"
|
|
4146
|
+
},
|
|
4147
|
+
{
|
|
4148
|
+
"const": "Healthcare"
|
|
4149
|
+
},
|
|
4150
|
+
{
|
|
4151
|
+
"const": "High Tech"
|
|
4152
|
+
},
|
|
4153
|
+
{
|
|
4154
|
+
"const": "Higher Education and Research"
|
|
4155
|
+
},
|
|
4156
|
+
{
|
|
4157
|
+
"const": "Industrial Machinery and Components"
|
|
4158
|
+
},
|
|
4159
|
+
{
|
|
4160
|
+
"const": "Insurance"
|
|
4161
|
+
},
|
|
4162
|
+
{
|
|
4163
|
+
"const": "Life Sciences"
|
|
4164
|
+
},
|
|
4165
|
+
{
|
|
4166
|
+
"const": "Media"
|
|
4167
|
+
},
|
|
4168
|
+
{
|
|
4169
|
+
"const": "Mill Products"
|
|
4170
|
+
},
|
|
4171
|
+
{
|
|
4172
|
+
"const": "Mining"
|
|
4173
|
+
},
|
|
4174
|
+
{
|
|
4175
|
+
"const": "Oil and Gas"
|
|
4176
|
+
},
|
|
4177
|
+
{
|
|
4178
|
+
"const": "Professional Services"
|
|
4179
|
+
},
|
|
4180
|
+
{
|
|
4181
|
+
"const": "Public Sector"
|
|
4182
|
+
},
|
|
4183
|
+
{
|
|
4184
|
+
"const": "Public Services"
|
|
4185
|
+
},
|
|
4186
|
+
{
|
|
4187
|
+
"const": "Retail"
|
|
4188
|
+
},
|
|
4189
|
+
{
|
|
4190
|
+
"const": "Service Industries"
|
|
4191
|
+
},
|
|
4192
|
+
{
|
|
4193
|
+
"const": "Sports and Entertainment"
|
|
4194
|
+
},
|
|
4195
|
+
{
|
|
4196
|
+
"const": "Telecommunications"
|
|
4197
|
+
},
|
|
4198
|
+
{
|
|
4199
|
+
"const": "Travel and Transportation"
|
|
4200
|
+
},
|
|
4201
|
+
{
|
|
4202
|
+
"const": "Utilities"
|
|
4203
|
+
},
|
|
4204
|
+
{
|
|
4205
|
+
"const": "Wholesale Distribution"
|
|
4206
|
+
}
|
|
4207
|
+
]
|
|
4208
|
+
},
|
|
4209
|
+
"description": "List of industry tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\n`industry` that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4210
|
+
"examples": [
|
|
4211
|
+
[
|
|
4212
|
+
"Automotive"
|
|
4213
|
+
],
|
|
4214
|
+
[
|
|
4215
|
+
"Retail",
|
|
4216
|
+
"Public Sector"
|
|
4217
|
+
],
|
|
4218
|
+
[]
|
|
4219
|
+
]
|
|
4220
|
+
},
|
|
4221
|
+
"relatedEntityTypes": {
|
|
4222
|
+
"type": "array",
|
|
4223
|
+
"description": "Optional list of related EntityType Resources.\n\nMUST be a valid reference to an [EntityType Resource](#entity-type) ORD ID.",
|
|
4224
|
+
"items": {
|
|
4225
|
+
"type": "string",
|
|
4226
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(entityType):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4227
|
+
"x-association-target": [
|
|
4228
|
+
"#/definitions/EntityType/ordId"
|
|
4229
|
+
]
|
|
4230
|
+
},
|
|
4231
|
+
"examples": [
|
|
4232
|
+
[
|
|
4233
|
+
"sap.odm:entityType:WorkforcePerson:v1"
|
|
4234
|
+
]
|
|
4235
|
+
]
|
|
4236
|
+
},
|
|
4237
|
+
"exposedApiResources": {
|
|
4238
|
+
"type": "array",
|
|
4239
|
+
"description": "Optional list of API Resources that expose the functionality of the agent. Typically using the A2A protocol, but other protocols are possible as well.\n\nMUST be a valid reference to an [API Resource](#api-resource) ORD ID.",
|
|
4240
|
+
"items": {
|
|
4241
|
+
"$ref": "#/definitions/ExposedApiResourcesTarget"
|
|
4242
|
+
},
|
|
4243
|
+
"examples": [
|
|
4244
|
+
[
|
|
4245
|
+
{
|
|
4246
|
+
"ordId": "sap.foo:apiResource:DisputeResolutionAgent:v1"
|
|
4247
|
+
}
|
|
4248
|
+
]
|
|
4249
|
+
]
|
|
4250
|
+
},
|
|
4251
|
+
"integrationDependencies": {
|
|
4252
|
+
"type": "array",
|
|
4253
|
+
"description": "Optional list of integration dependencies that the agent relies on.\n\nMUST be a valid reference to an [Integration Dependency](#integration-dependency) ORD ID.",
|
|
4254
|
+
"items": {
|
|
4255
|
+
"type": "string",
|
|
4256
|
+
"pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):(integrationDependency):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4257
|
+
"maxLength": 255,
|
|
4258
|
+
"x-association-target": [
|
|
4259
|
+
"#/definitions/IntegrationDependency/ordId"
|
|
4260
|
+
]
|
|
4261
|
+
},
|
|
4262
|
+
"examples": [
|
|
4263
|
+
[
|
|
4264
|
+
"sap.foo.bar:integrationDependency:DisputeCaseManagement:v1"
|
|
4265
|
+
]
|
|
4266
|
+
]
|
|
4267
|
+
},
|
|
4268
|
+
"links": {
|
|
4269
|
+
"type": "array",
|
|
4270
|
+
"description": "Generic Links with arbitrary meaning and content.",
|
|
4271
|
+
"items": {
|
|
4272
|
+
"$ref": "#/definitions/Link"
|
|
4273
|
+
}
|
|
4274
|
+
},
|
|
4275
|
+
"tags": {
|
|
4276
|
+
"type": "array",
|
|
4277
|
+
"items": {
|
|
4278
|
+
"type": "string",
|
|
4279
|
+
"pattern": "^[a-zA-Z0-9-_.\\/ ]*$",
|
|
4280
|
+
"minLength": 1
|
|
4281
|
+
},
|
|
4282
|
+
"description": "List of free text style tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\nTags that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4283
|
+
"examples": [
|
|
4284
|
+
[
|
|
4285
|
+
"storage",
|
|
4286
|
+
"high-availability"
|
|
4287
|
+
]
|
|
4288
|
+
]
|
|
4289
|
+
},
|
|
4290
|
+
"labels": {
|
|
4291
|
+
"$ref": "#/definitions/Labels"
|
|
4292
|
+
},
|
|
4293
|
+
"documentationLabels": {
|
|
4294
|
+
"$ref": "#/definitions/DocumentationLabels"
|
|
4295
|
+
}
|
|
4296
|
+
},
|
|
4297
|
+
"additionalProperties": false,
|
|
4298
|
+
"required": [
|
|
4299
|
+
"ordId",
|
|
4300
|
+
"title",
|
|
4301
|
+
"version",
|
|
4302
|
+
"releaseStatus",
|
|
4303
|
+
"visibility",
|
|
4304
|
+
"partOfPackage"
|
|
4305
|
+
],
|
|
4306
|
+
"x-recommended": [
|
|
4307
|
+
"lastUpdate"
|
|
4308
|
+
]
|
|
4309
|
+
},
|
|
4310
|
+
"Product": {
|
|
4311
|
+
"type": "object",
|
|
4312
|
+
"title": "Product",
|
|
4313
|
+
"x-ums-type": "root",
|
|
4314
|
+
"description": "A **product** in ORD is understood as a commercial product or service.\n\nIt is a high-level entity for structuring the software portfolio from a sales / software logistics perspective.\nWhile **system type** is a technical concept, **product** covers the commercial 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.",
|
|
4315
|
+
"properties": {
|
|
4316
|
+
"ordId": {
|
|
4317
|
+
"type": "string",
|
|
4318
|
+
"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.",
|
|
4319
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
|
|
4320
|
+
"maxLength": 255,
|
|
4321
|
+
"examples": [
|
|
4322
|
+
"sap:product:S4HANA_OD:"
|
|
4323
|
+
]
|
|
4324
|
+
},
|
|
4325
|
+
"correlationIds": {
|
|
4326
|
+
"type": "array",
|
|
4327
|
+
"description": "Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).\n\nThey express an \"identity\" / \"equals\" / \"mappable\" relationship to the target ID.\n\nIf a \"part of\" relationship needs to be expressed, use the `partOfGroups` assignment instead.\n\nMUST be a valid [Correlation ID](../index.md#correlation-id).",
|
|
4328
|
+
"items": {
|
|
4329
|
+
"type": "string",
|
|
4330
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
4331
|
+
"maxLength": 255
|
|
4332
|
+
},
|
|
4333
|
+
"examples": [
|
|
4334
|
+
[
|
|
4335
|
+
"sap.xref:product:ABC"
|
|
4336
|
+
]
|
|
4337
|
+
]
|
|
4338
|
+
},
|
|
4339
|
+
"title": {
|
|
4340
|
+
"type": "string",
|
|
4341
|
+
"description": "Human-readable title.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
4342
|
+
"minLength": 1,
|
|
4343
|
+
"maxLength": 255,
|
|
4344
|
+
"examples": [
|
|
4345
|
+
"SAP S/4HANA Cloud"
|
|
4346
|
+
]
|
|
4347
|
+
},
|
|
4348
|
+
"shortDescription": {
|
|
4349
|
+
"type": "string",
|
|
4350
|
+
"description": "Plain text short description.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
4351
|
+
"minLength": 1,
|
|
4352
|
+
"maxLength": 255,
|
|
4353
|
+
"examples": [
|
|
4354
|
+
"The next generation digital core designed to help you run simple in a digital economy."
|
|
4355
|
+
]
|
|
4356
|
+
},
|
|
4357
|
+
"description": {
|
|
4358
|
+
"type": "string",
|
|
4359
|
+
"minLength": 1,
|
|
4360
|
+
"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.",
|
|
4361
|
+
"examples": []
|
|
4362
|
+
},
|
|
4363
|
+
"vendor": {
|
|
4364
|
+
"type": "string",
|
|
4365
|
+
"description": "Vendor / organization that is responsible for the Product.\n\nMUST be a valid reference to a [Vendor](#vendor) ORD ID.",
|
|
4366
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(vendor):([a-zA-Z0-9._\\-]+):()$",
|
|
4367
|
+
"maxLength": 256,
|
|
4368
|
+
"x-association-target": [
|
|
4369
|
+
"#/definitions/Vendor/ordId"
|
|
4370
|
+
],
|
|
4371
|
+
"examples": [
|
|
4372
|
+
"sap:vendor:SAP:",
|
|
4373
|
+
"customer:vendor:Customer:",
|
|
4374
|
+
"microsoft:vendor:Microsoft:"
|
|
4375
|
+
]
|
|
4376
|
+
},
|
|
4377
|
+
"parent": {
|
|
4378
|
+
"type": "string",
|
|
4379
|
+
"description": "Optional product parent ORD ID, if a hierarchical product structure needs to be expressed.\n\nMUST be a valid reference to a [Product](#product) ORD ID.",
|
|
4380
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
|
|
4381
|
+
"x-association-target": [
|
|
4382
|
+
"#/definitions/Product/ordId"
|
|
4383
|
+
],
|
|
4384
|
+
"examples": [
|
|
4385
|
+
"sap:product:S4HANA_OD:"
|
|
4386
|
+
]
|
|
4387
|
+
},
|
|
4388
|
+
"tags": {
|
|
4389
|
+
"type": "array",
|
|
4390
|
+
"items": {
|
|
4391
|
+
"type": "string",
|
|
4392
|
+
"pattern": "^[a-zA-Z0-9-_.\\/ ]*$",
|
|
4393
|
+
"minLength": 1
|
|
4394
|
+
},
|
|
4395
|
+
"description": "List of free text style tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\nTags that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4396
|
+
"examples": [
|
|
4397
|
+
[
|
|
4398
|
+
"storage",
|
|
4399
|
+
"high-availability"
|
|
4400
|
+
]
|
|
4401
|
+
]
|
|
4402
|
+
},
|
|
4403
|
+
"labels": {
|
|
4404
|
+
"$ref": "#/definitions/Labels"
|
|
4405
|
+
},
|
|
4406
|
+
"documentationLabels": {
|
|
4407
|
+
"$ref": "#/definitions/DocumentationLabels"
|
|
4408
|
+
}
|
|
4409
|
+
},
|
|
4410
|
+
"additionalProperties": false,
|
|
4411
|
+
"required": [
|
|
4412
|
+
"ordId",
|
|
4413
|
+
"title",
|
|
4414
|
+
"shortDescription",
|
|
4415
|
+
"vendor"
|
|
4416
|
+
]
|
|
4417
|
+
},
|
|
4418
|
+
"Capability": {
|
|
4419
|
+
"type": "object",
|
|
4420
|
+
"title": "Capability",
|
|
4421
|
+
"x-ums-type": "root",
|
|
4422
|
+
"x-introduced-in-version": "1.4.0",
|
|
4423
|
+
"description": "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.\nThis is a generic ORD concept that aims to cover many different capability discovery use cases that would otherwise need be implemented as individual service provider interfaces (SPIs).\n\nIf a capability needs to expose more information than possible with generic capability properties, a custom capability definition can be defined and referenced in ORD.\nThis is the same idea and mechanism as with API resources and their resource definition formats.",
|
|
4424
|
+
"properties": {
|
|
4425
|
+
"ordId": {
|
|
4426
|
+
"type": "string",
|
|
4427
|
+
"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.",
|
|
4428
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(capability):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4429
|
+
"maxLength": 255,
|
|
4430
|
+
"examples": [
|
|
4431
|
+
"sap.foo.bar:capability:fieldExtensibility:v1"
|
|
4432
|
+
]
|
|
4433
|
+
},
|
|
4434
|
+
"localId": {
|
|
4435
|
+
"type": "string",
|
|
4436
|
+
"x-introduced-in-version": "1.2.1",
|
|
4437
|
+
"description": "The locally unique ID under which this resource can be looked up / resolved in the described system itself.\nUnlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.\n\nIt MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.\nBut since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.",
|
|
4438
|
+
"maxLength": 255,
|
|
4439
|
+
"examples": [
|
|
4440
|
+
"SuccessFactorsRecruiting",
|
|
4441
|
+
"91cd9972-c05d-4d29-8b6e-dbef2a2d48e9"
|
|
4442
|
+
]
|
|
4443
|
+
},
|
|
4444
|
+
"correlationIds": {
|
|
4445
|
+
"type": "array",
|
|
4446
|
+
"description": "Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).\n\nThey express an \"identity\" / \"equals\" / \"mappable\" relationship to the target ID.\n\nIf a \"part of\" relationship needs to be expressed, use the `partOfGroups` assignment instead.\n\nMUST be a valid [Correlation ID](../index.md#correlation-id).",
|
|
4447
|
+
"items": {
|
|
4448
|
+
"type": "string",
|
|
4449
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
4450
|
+
"maxLength": 255
|
|
4451
|
+
},
|
|
4452
|
+
"examples": [
|
|
4453
|
+
[
|
|
4454
|
+
"sap.s4:communicationScenario:SAP_COM_0008"
|
|
4455
|
+
]
|
|
4456
|
+
]
|
|
4457
|
+
},
|
|
4458
|
+
"type": {
|
|
4459
|
+
"description": "Type of the Capability",
|
|
4460
|
+
"type": "string",
|
|
4461
|
+
"anyOf": [
|
|
4462
|
+
{
|
|
4463
|
+
"type": "string",
|
|
4464
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4465
|
+
"description": "Any valid [Specification ID](../index.md#specification-id)."
|
|
4466
|
+
},
|
|
4467
|
+
{
|
|
4468
|
+
"const": "sap.mdo:mdi-capability:v1",
|
|
4469
|
+
"description": "Capability for SAP Master Data Integration (MDI).\n\nFor the capability definitions: `type` MUST ONLY be set to `sap.mdo:mdi-capability-definition:v1`."
|
|
4470
|
+
},
|
|
4471
|
+
{
|
|
4472
|
+
"const": "custom",
|
|
4473
|
+
"description": "If chosen, `customType` MUST be provided."
|
|
4474
|
+
}
|
|
4475
|
+
],
|
|
4476
|
+
"examples": [
|
|
4477
|
+
"custom"
|
|
4478
|
+
]
|
|
4479
|
+
},
|
|
4480
|
+
"customType": {
|
|
4481
|
+
"type": "string",
|
|
4482
|
+
"description": "If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.\n\nMUST be a valid [Specification ID](../index.md#specification-id).\n\nMUST only be provided if `type` is set to `custom`.",
|
|
4483
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4484
|
+
"maxLength": 255,
|
|
4485
|
+
"examples": [
|
|
4486
|
+
"sap:custom-definition-format:v1"
|
|
4487
|
+
]
|
|
4488
|
+
},
|
|
4489
|
+
"title": {
|
|
4490
|
+
"type": "string",
|
|
4491
|
+
"description": "Human-readable title.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
4492
|
+
"minLength": 1,
|
|
4493
|
+
"maxLength": 255,
|
|
4494
|
+
"examples": [
|
|
4495
|
+
"MDI Capability"
|
|
4496
|
+
]
|
|
4497
|
+
},
|
|
4498
|
+
"shortDescription": {
|
|
4499
|
+
"type": "string",
|
|
4500
|
+
"description": "Plain text short description.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
|
|
4501
|
+
"minLength": 1,
|
|
4502
|
+
"maxLength": 255,
|
|
4503
|
+
"examples": [
|
|
4504
|
+
"SAP S/4HANA Cloud, our next generation cloud ERP suite designed for in-memory computing."
|
|
4505
|
+
]
|
|
4506
|
+
},
|
|
4507
|
+
"description": {
|
|
4508
|
+
"type": "string",
|
|
4509
|
+
"minLength": 1,
|
|
4510
|
+
"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.",
|
|
4511
|
+
"examples": [
|
|
4512
|
+
"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"
|
|
4513
|
+
]
|
|
4514
|
+
},
|
|
4515
|
+
"partOfPackage": {
|
|
4516
|
+
"type": "string",
|
|
4517
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(package):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4518
|
+
"x-association-target": [
|
|
4519
|
+
"#/definitions/Package/ordId"
|
|
4520
|
+
],
|
|
4521
|
+
"maxLength": 255,
|
|
4522
|
+
"description": "Defines which Package the resource is part of.\n\nMUST be a valid reference to a [Package](#package) ORD ID.\n\nEvery resource MUST be part of one package.",
|
|
4523
|
+
"examples": [
|
|
4524
|
+
"sap.xref:package:SomePackage:v1"
|
|
4525
|
+
]
|
|
4526
|
+
},
|
|
4527
|
+
"partOfGroups": {
|
|
4528
|
+
"type": "array",
|
|
4529
|
+
"items": {
|
|
4530
|
+
"type": "string",
|
|
4531
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+)$",
|
|
4532
|
+
"x-association-target": [
|
|
4533
|
+
"#/definitions/Group/groupId"
|
|
4534
|
+
]
|
|
4535
|
+
},
|
|
4536
|
+
"description": "Defines which groups the resource is assigned to.\n\nThe property is optional, but if given the value MUST be an array of valid Group IDs.\n\nGroups are a lightweight custom taxonomy concept.\nThey express a \"part of\" relationship to the chosen group concept.\nIf an \"identity / equals\" relationship needs to be expressed, use the `correlationIds` instead.\n\nAll resources that share the same group ID assignment are effectively grouped together."
|
|
4537
|
+
},
|
|
4538
|
+
"version": {
|
|
4539
|
+
"type": "string",
|
|
4540
|
+
"description": "The complete [SemVer](https://semver.org/) version string.\n\nIt MUST follow the [Semantic Versioning 2.0.0](https://semver.org/) standard.\nIt SHOULD be changed if the ORD information or referenced resource definitions changed.\nIt SHOULD express minor and patch changes that don't lead to incompatible changes.\n\nWhen the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.\nIn case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.\n\nIf the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.\nThe `version` MUST not be bumped for changes in extensions.\n\nThe general [Version and Lifecycle](../index.md#version-and-lifecycle) flow MUST be followed.\n\nNote: A change is only relevant for a version increment, if it affects the ORD resource or ORD taxonomy directly.\nFor example: If a resource within a `Package` changes, but the Package itself did not, the Package version does not need to be incremented.",
|
|
4541
|
+
"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-]+)*))?$",
|
|
4542
|
+
"examples": [
|
|
4543
|
+
"1.2.3",
|
|
4544
|
+
"1.0.0-alpha.1"
|
|
4545
|
+
]
|
|
4546
|
+
},
|
|
4547
|
+
"lastUpdate": {
|
|
4548
|
+
"type": "string",
|
|
4549
|
+
"format": "date-time",
|
|
4550
|
+
"x-introduced-in-version": "1.4.0",
|
|
4551
|
+
"description": "Optional, but RECOMMENDED indicator when (date-time) the last change to the resource (including its definitions) happened.\n\nThe date format MUST comply with [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).\n\nWhen retrieved from an ORD aggregator, `lastUpdate` will be reliable there and reflect either the provider based update time or the aggregator processing time.\nTherefore consumers MAY rely on it to detect changes to the metadata and the attached resource definition files.\n\nIf the resource has attached definitions, either the `version` or `lastUpdate` property MUST be defined and updated to let the ORD aggregator know that they need to be fetched again.\n\nTogether with `perspectives`, this property SHOULD be used to optimize the metadata crawling process of the ORD aggregators.",
|
|
4552
|
+
"examples": [
|
|
4553
|
+
"2022-12-19T15:47:04+00:00"
|
|
4554
|
+
]
|
|
4555
|
+
},
|
|
4556
|
+
"visibility": {
|
|
4557
|
+
"type": "string",
|
|
4558
|
+
"description": "The visibility states who is allowed to \"see\" the described resource or capability.",
|
|
4559
|
+
"oneOf": [
|
|
4560
|
+
{
|
|
4561
|
+
"const": "public",
|
|
4562
|
+
"description": "Publicly visible to customers and 3rd parties.\nUsually this includes an contract on the API stability, e.g. the [SAP API Deprecation Policy](https://help.sap.com/viewer/84b35b9c39b247e3ba2a31f02beee46d/Cloud/en-US/5cbfda5a9efe4e97a3e24ddaf7ec5c16.html)."
|
|
4563
|
+
},
|
|
4564
|
+
{
|
|
4565
|
+
"const": "internal",
|
|
4566
|
+
"description": "Visible to other applications within the same [vendor](#vendor).\nHowever, they are not officially exposed and communicated to customers and 3rd parties.\nThey might not come with the same guarantees on API stability.\n\nInternal resources MUST NOT be made available to consumers without checking the necessary access permissions, e.g., a public API Catalog.\nInternal resources MAY be published through an internal API Catalog if the access permissions are ensured by it."
|
|
4567
|
+
},
|
|
4568
|
+
{
|
|
4569
|
+
"const": "private",
|
|
4570
|
+
"description": "Visible only to the provider application or service, usually within the same system namespace / system type.\n\nPrivate resources MUST NOT be made available to public consumers or consumers outside of the \"private\" scope of the described application."
|
|
4571
|
+
}
|
|
4572
|
+
]
|
|
4573
|
+
},
|
|
4574
|
+
"releaseStatus": {
|
|
4575
|
+
"type": "string",
|
|
4576
|
+
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
4577
|
+
"oneOf": [
|
|
4578
|
+
{
|
|
4579
|
+
"const": "beta",
|
|
4580
|
+
"description": "The contract for the resource is beta and may not be meant for productive use.\nResources of `beta` status MAY be changed or deleted at the providers discretion."
|
|
4581
|
+
},
|
|
4582
|
+
{
|
|
4583
|
+
"const": "active",
|
|
4584
|
+
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
4585
|
+
},
|
|
4586
|
+
{
|
|
4587
|
+
"const": "deprecated",
|
|
4588
|
+
"description": "Resource has been deprecated.\n\nIf the `releaseStatus` is set to `deprecated`, the `deprecationDate` SHOULD be provided.\n\nIf successor resources exist, they MUST be referenced through `successors`.\n\nA deprecated resource MAY be sunset (aka. decommissioned / removed) in the future, through setting a `Tombstone`.\nOnce the resource is sunset, its description MAY be removed from ORD, but could also be kept with `releaseStatus` set to `sunset`."
|
|
4589
|
+
},
|
|
4590
|
+
{
|
|
4591
|
+
"const": "sunset",
|
|
4592
|
+
"description": "Resource has been sunset, but is still described.\nIf the status is set to `sunset`, a `Tombstone` MUST be set as well and a `sunsetDate` MUST be provided."
|
|
4593
|
+
}
|
|
4594
|
+
],
|
|
4595
|
+
"examples": [
|
|
4596
|
+
"active"
|
|
4597
|
+
]
|
|
4598
|
+
},
|
|
4599
|
+
"disabled": {
|
|
4600
|
+
"type": "boolean",
|
|
4601
|
+
"default": false,
|
|
4602
|
+
"description": "Indicates that this resource is currently not available for consumption at runtime, but could be configured to be so.\nThis can happen either because it has not been setup for use or disabled by an admin / user.\n\nIf the resource is not available in principle for a particular system instance, e.g. due to lack of entitlement, it MUST not be described in the system-instance-aware perspective.\n\nThis property can only reflect the knowledge of the described system instance itself.\nOutside factors for availability can't need to be considered (e.g. network connectivity, middlewares).\n\nA disabled resource MAY skip describing its resource definitions.\n"
|
|
4603
|
+
},
|
|
4604
|
+
"minSystemVersion": {
|
|
4605
|
+
"type": "string",
|
|
4606
|
+
"description": "The resource has been introduced in the given [system version](../index.md#system-version).\nThis implies that the resource is only available if the system instance is of at least that system version.\n\nIt MUST follow the [Semantic Versioning 2.0.0](https://semver.org/) standard.",
|
|
4607
|
+
"x-introduced-in-version": "1.10.0",
|
|
4608
|
+
"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-]+)*))?$",
|
|
4609
|
+
"examples": [
|
|
4610
|
+
"1.2.3",
|
|
4611
|
+
"2024.8.0"
|
|
4612
|
+
]
|
|
4613
|
+
},
|
|
4614
|
+
"relatedEntityTypes": {
|
|
4615
|
+
"type": "array",
|
|
4616
|
+
"description": "Optional list of related EntityType Resources.\nMUST be a valid reference to an [EntityType Resource](#entity-type) ORD ID.",
|
|
4617
|
+
"items": {
|
|
4618
|
+
"type": "string",
|
|
4619
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(entityType):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
4620
|
+
"x-association-target": [
|
|
4621
|
+
"#/definitions/EntityType/ordId"
|
|
4622
|
+
]
|
|
4623
|
+
},
|
|
4624
|
+
"examples": [
|
|
4625
|
+
[
|
|
4626
|
+
"sap.odm:entityType:WorkforcePerson:v1"
|
|
4627
|
+
]
|
|
4628
|
+
]
|
|
4629
|
+
},
|
|
4630
|
+
"definitions": {
|
|
4631
|
+
"type": "array",
|
|
4632
|
+
"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.",
|
|
4633
|
+
"items": {
|
|
4634
|
+
"$ref": "#/definitions/CapabilityDefinition"
|
|
4635
|
+
}
|
|
4636
|
+
},
|
|
4637
|
+
"links": {
|
|
4638
|
+
"type": "array",
|
|
4639
|
+
"description": "Generic Links with arbitrary meaning and content.",
|
|
4640
|
+
"items": {
|
|
4641
|
+
"$ref": "#/definitions/Link"
|
|
4642
|
+
}
|
|
4643
|
+
},
|
|
4644
|
+
"tags": {
|
|
4645
|
+
"type": "array",
|
|
4646
|
+
"items": {
|
|
4647
|
+
"type": "string",
|
|
4648
|
+
"pattern": "^[a-zA-Z0-9-_.\\/ ]*$",
|
|
4649
|
+
"minLength": 1
|
|
4650
|
+
},
|
|
4651
|
+
"description": "List of free text style tags.\nNo special characters are allowed except `-`, `_`, `.`, `/` and ` `.\n\nTags that are assigned to a `Package` are inherited to all of the ORD resources it contains.",
|
|
4652
|
+
"examples": [
|
|
4653
|
+
[
|
|
4654
|
+
"storage",
|
|
4655
|
+
"high-availability"
|
|
4656
|
+
]
|
|
4657
|
+
]
|
|
4658
|
+
},
|
|
4659
|
+
"labels": {
|
|
4660
|
+
"$ref": "#/definitions/Labels"
|
|
4661
|
+
},
|
|
4662
|
+
"documentationLabels": {
|
|
4663
|
+
"$ref": "#/definitions/DocumentationLabels"
|
|
4664
|
+
},
|
|
4665
|
+
"systemInstanceAware": {
|
|
4666
|
+
"type": "boolean",
|
|
4076
4667
|
"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).",
|
|
4077
4668
|
"default": false,
|
|
4078
4669
|
"examples": [
|
|
@@ -4098,6 +4689,7 @@
|
|
|
4098
4689
|
"type": "object",
|
|
4099
4690
|
"title": "Capability Definition",
|
|
4100
4691
|
"x-introduced-in-version": "1.4.0",
|
|
4692
|
+
"x-ums-type": "custom",
|
|
4101
4693
|
"description": "Link and categorization of a machine-readable capability definition.",
|
|
4102
4694
|
"properties": {
|
|
4103
4695
|
"type": {
|
|
@@ -4209,6 +4801,7 @@
|
|
|
4209
4801
|
"IntegrationDependency": {
|
|
4210
4802
|
"type": "object",
|
|
4211
4803
|
"title": "Integration Dependency",
|
|
4804
|
+
"x-ums-type": "root",
|
|
4212
4805
|
"x-introduced-in-version": "1.7.0",
|
|
4213
4806
|
"description": "An [Integration Dependency](../concepts/integration-dependency) states that the described system (self) can integrate with external systems (integration target) to achieve an integration purpose.\nThe purpose could be to enable a certain feature or integration scenario, but it could also be a mandatory prerequisite for the described system to work.\n\nThe integration dependency includes a list of individual **aspects** that the integration consists of.\nAspects are an \"ingredient\" for the integration scenario (and are logically combined with AND condition).\nEach aspect can express alternatives (OR condition) on what API and event resources can be used to achieve the same outcome.\n\nThe direction of connection establishment, data flow is not directly implied and needs to be inferred from the referenced resources.\n\nIt is not in scope for the Integration Dependency to describe scenarios that external consumers have with the own exposed resources.\nThis would overstep the boundary of self-description.\n\nIf an integration scenario consists of two sides integration with each other, each need to describe its own part in it as an Integration Dependency.\nTherefore, if an integration with multiple types of systems need to be setup, this SHOULD be separated into distinct Integration Dependencies.\n\nAn integration dependency is also not meant to describe a bigger process.\nInstead it focuses on the technical necessaries to create an integration for one particular purpose.\n\nTo learn more about the concept, see [Integration Dependency](../concepts/integration-dependency).",
|
|
4214
4807
|
"properties": {
|
|
@@ -4451,6 +5044,7 @@
|
|
|
4451
5044
|
"type": "object",
|
|
4452
5045
|
"title": "Aspect",
|
|
4453
5046
|
"x-introduced-in-version": "1.7.0",
|
|
5047
|
+
"x-ums-type": "custom",
|
|
4454
5048
|
"description": "An (integration) aspect is the constituent part that makes up an Integration Dependency.\n\nEach aspect can list references to resources, which could be owned and defined by the integration target or by the described system itself.\nIn case the reference links to own resources, it is implied that they are to be used by the integration target to fulfill the Integration Dependency.\n\nIf multiple resources are given within an aspect, they are considered alternatives to each other (OR condition).\nIn case an AND condition is needed, multiple aspects need to be added to the Integration Dependency.",
|
|
4455
5049
|
"properties": {
|
|
4456
5050
|
"title": {
|
|
@@ -4503,6 +5097,7 @@
|
|
|
4503
5097
|
"type": "object",
|
|
4504
5098
|
"title": "Api Resource Integration Aspect",
|
|
4505
5099
|
"x-introduced-in-version": "1.7.0",
|
|
5100
|
+
"x-ums-type": "custom",
|
|
4506
5101
|
"description": "API resource related integration aspect",
|
|
4507
5102
|
"properties": {
|
|
4508
5103
|
"ordId": {
|
|
@@ -4522,6 +5117,13 @@
|
|
|
4522
5117
|
"1.2.3",
|
|
4523
5118
|
"1.0.0-alpha.1"
|
|
4524
5119
|
]
|
|
5120
|
+
},
|
|
5121
|
+
"subset": {
|
|
5122
|
+
"type": "array",
|
|
5123
|
+
"description": "List of individual API operations that are sufficient to achieve the aspect.",
|
|
5124
|
+
"items": {
|
|
5125
|
+
"$ref": "#/definitions/ApiResourceIntegrationAspectSubset"
|
|
5126
|
+
}
|
|
4525
5127
|
}
|
|
4526
5128
|
},
|
|
4527
5129
|
"additionalProperties": false,
|
|
@@ -4533,6 +5135,7 @@
|
|
|
4533
5135
|
"type": "object",
|
|
4534
5136
|
"title": "Event Resource Integration Aspect",
|
|
4535
5137
|
"x-introduced-in-version": "1.7.0",
|
|
5138
|
+
"x-ums-type": "custom",
|
|
4536
5139
|
"description": "Event resource related integration aspect",
|
|
4537
5140
|
"properties": {
|
|
4538
5141
|
"ordId": {
|
|
@@ -4585,6 +5188,7 @@
|
|
|
4585
5188
|
"type": "object",
|
|
4586
5189
|
"title": "Event Resource Integration Aspect Subset",
|
|
4587
5190
|
"x-introduced-in-version": "1.7.0",
|
|
5191
|
+
"x-ums-type": "custom",
|
|
4588
5192
|
"description": "Defines that Event Resource Integration Aspect only requires a subset of the referenced contract.\n\nFor events, this could be a list of the events that need to be subscribed in order to make the integration work.\nThis information helps to narrow down what is really necessary and can help optimize the integration, e.g. by only publishing the events that are really needed.",
|
|
4589
5193
|
"properties": {
|
|
4590
5194
|
"eventType": {
|
|
@@ -4600,9 +5204,31 @@
|
|
|
4600
5204
|
"eventType"
|
|
4601
5205
|
]
|
|
4602
5206
|
},
|
|
5207
|
+
"ApiResourceIntegrationAspectSubset": {
|
|
5208
|
+
"type": "object",
|
|
5209
|
+
"title": "API Resource Integration Aspect Subset",
|
|
5210
|
+
"x-introduced-in-version": "1.10.0",
|
|
5211
|
+
"x-ums-type": "custom",
|
|
5212
|
+
"description": "Defines that API Resource Integration Aspect only requires a subset of the referenced contract.\n\nFor APIs, this is a list of the operations or tools that need to be available in order to make the integration work.\nThis information helps to narrow down what is really necessary and can help optimize the integration.",
|
|
5213
|
+
"properties": {
|
|
5214
|
+
"operationId": {
|
|
5215
|
+
"type": "string",
|
|
5216
|
+
"description": "The ID of the individual API operation or tool.\n\nThis MUST be an ID that is understood by the used protocol and resource definition format.\nE.g. for OpenAPI this is the `operationId`, for MCP this is the tool `name`.",
|
|
5217
|
+
"examples": [
|
|
5218
|
+
"getOrderById",
|
|
5219
|
+
"createCustomer"
|
|
5220
|
+
]
|
|
5221
|
+
}
|
|
5222
|
+
},
|
|
5223
|
+
"additionalProperties": false,
|
|
5224
|
+
"required": [
|
|
5225
|
+
"operationId"
|
|
5226
|
+
]
|
|
5227
|
+
},
|
|
4603
5228
|
"Vendor": {
|
|
4604
5229
|
"type": "object",
|
|
4605
5230
|
"title": "Vendor",
|
|
5231
|
+
"x-ums-type": "root",
|
|
4606
5232
|
"description": "The vendor of a product or a package, usually a corporation or a customer / user.\n\nThe vendor of a `Package` is the owner or creator of the content of the package.\nThe vendor of a `Product` is the owner of the product.\n\nIf the resources are created by the customer / user of the described system, `customer:vendor:Customer:` MUST be used as vendor.\n\nBoth have already a [vendor namespace](../index.md#vendor-namespace) within their ORD ID.\nThe `Vendor` entity is giving more details on the vendor namespace.\nFor one vendor namespace there MUST only be exactly one `Vendor` ORD entity describing it.\n\nFor example: The only correct value for a SAP vendor reference is `sap:vendor:SAP:`.",
|
|
4607
5233
|
"properties": {
|
|
4608
5234
|
"ordId": {
|
|
@@ -4673,6 +5299,7 @@
|
|
|
4673
5299
|
"type": "object",
|
|
4674
5300
|
"title": "Changelog Entry",
|
|
4675
5301
|
"description": "A changelog entry can be used to indicate changes.\nUsually they lead to a change of the version number or the release status.",
|
|
5302
|
+
"x-ums-type": "custom",
|
|
4676
5303
|
"properties": {
|
|
4677
5304
|
"version": {
|
|
4678
5305
|
"type": "string",
|
|
@@ -4740,6 +5367,7 @@
|
|
|
4740
5367
|
"type": "object",
|
|
4741
5368
|
"title": "Link",
|
|
4742
5369
|
"description": "Link that can be attached to packages or Open Resource Discovery resources.\n",
|
|
5370
|
+
"x-ums-type": "custom",
|
|
4743
5371
|
"properties": {
|
|
4744
5372
|
"title": {
|
|
4745
5373
|
"type": "string",
|
|
@@ -4781,6 +5409,7 @@
|
|
|
4781
5409
|
"PackageLink": {
|
|
4782
5410
|
"type": "object",
|
|
4783
5411
|
"title": "Package Link",
|
|
5412
|
+
"x-ums-type": "custom",
|
|
4784
5413
|
"description": "Links with specific semantic meaning that are related to `Package`.\n\nIf a generic [Link](#link) can also be expressed via a Package Link, the latter MUST be chosen.",
|
|
4785
5414
|
"properties": {
|
|
4786
5415
|
"type": {
|
|
@@ -4860,6 +5489,7 @@
|
|
|
4860
5489
|
"APIEventResourceLink": {
|
|
4861
5490
|
"type": "object",
|
|
4862
5491
|
"title": "Api and Event Resource Link",
|
|
5492
|
+
"x-ums-type": "custom",
|
|
4863
5493
|
"description": "Links with specific semantic meaning that are related to API or event resources.\n\nIf a generic [Link](#link) can also be expressed via an API / Event Resource Link, the latter MUST be chosen.",
|
|
4864
5494
|
"properties": {
|
|
4865
5495
|
"type": {
|
|
@@ -4942,6 +5572,7 @@
|
|
|
4942
5572
|
"DataProductLink": {
|
|
4943
5573
|
"type": "object",
|
|
4944
5574
|
"title": "Data Product Link",
|
|
5575
|
+
"x-ums-type": "custom",
|
|
4945
5576
|
"description": "Links with specific semantic meaning that are related to Data Product resources.\nIf a generic [Link](#link) can also be expressed via Data Product Link, the latter MUST be chosen.",
|
|
4946
5577
|
"properties": {
|
|
4947
5578
|
"type": {
|
|
@@ -5010,6 +5641,7 @@
|
|
|
5010
5641
|
"SystemInstance": {
|
|
5011
5642
|
"type": "object",
|
|
5012
5643
|
"title": "System Instance",
|
|
5644
|
+
"x-ums-type": "ignore",
|
|
5013
5645
|
"description": "A [system instance](../index.md#system-instance) is a concrete, running instance of a system type.\nIn a multi-tenant system, it corresponds to a tenant.\nIn a single-tenant system, it corresponds to the [system installation](../index.md#system-deployment) itself.",
|
|
5014
5646
|
"properties": {
|
|
5015
5647
|
"baseUrl": {
|
|
@@ -5074,6 +5706,7 @@
|
|
|
5074
5706
|
"type": "object",
|
|
5075
5707
|
"title": "System Type",
|
|
5076
5708
|
"description": "A [system type](../index.md#system-type) is the abstract type of an application or service, from operational perspective.",
|
|
5709
|
+
"x-ums-type": "ignore",
|
|
5077
5710
|
"properties": {
|
|
5078
5711
|
"systemNamespace": {
|
|
5079
5712
|
"type": "string",
|
|
@@ -5128,6 +5761,7 @@
|
|
|
5128
5761
|
"type": "object",
|
|
5129
5762
|
"title": "System Version",
|
|
5130
5763
|
"description": "A [system version](../index.md#system-version) states the design-time version / release of a [system instance](../index.md#system-instance).\nIt provides versioning for operational purposes for the [system type](../index.md#system-type).",
|
|
5764
|
+
"x-ums-type": "ignore",
|
|
5131
5765
|
"properties": {
|
|
5132
5766
|
"version": {
|
|
5133
5767
|
"type": "string",
|
|
@@ -5185,6 +5819,7 @@
|
|
|
5185
5819
|
"type": "object",
|
|
5186
5820
|
"title": "Metadata Definition Access Strategy",
|
|
5187
5821
|
"description": "Defines the [access strategy](../../spec-extensions/access-strategies/) for accessing the resource definitions.",
|
|
5822
|
+
"x-ums-type": "custom",
|
|
5188
5823
|
"properties": {
|
|
5189
5824
|
"type": {
|
|
5190
5825
|
"type": "string",
|
|
@@ -5250,6 +5885,7 @@
|
|
|
5250
5885
|
"type": "object",
|
|
5251
5886
|
"title": "Credential Exchange Strategy",
|
|
5252
5887
|
"x-feature-status": "alpha",
|
|
5888
|
+
"x-ums-type": "custom",
|
|
5253
5889
|
"description": "The credential exchange strategy specifies how a set of credentials for a particular usage\nof the APIs in the Consumption Bundle can be obtained.\nUntil a SAP-wide strategy for obtaining such credentials exists and is agreed upon,\nboth LoBs and aggregators (namely Unified Customer Landscape) can define their own strategy specifications.\n\nWhile the actual flow in term of API calls can differ between the different strategies,\nthe end goal would always be the possibility for automatically obtaining credentials for each client\nthat would like to use the APIs from a particular bundle.",
|
|
5254
5890
|
"properties": {
|
|
5255
5891
|
"type": {
|
|
@@ -5300,6 +5936,7 @@
|
|
|
5300
5936
|
"title": "Labels",
|
|
5301
5937
|
"type": "object",
|
|
5302
5938
|
"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.",
|
|
5939
|
+
"x-ums-type": "custom",
|
|
5303
5940
|
"patternProperties": {
|
|
5304
5941
|
"^[a-zA-Z0-9-_.]*$": {
|
|
5305
5942
|
"type": "array",
|
|
@@ -5321,6 +5958,7 @@
|
|
|
5321
5958
|
"GroupType": {
|
|
5322
5959
|
"title": "Group Type",
|
|
5323
5960
|
"type": "object",
|
|
5961
|
+
"x-ums-type": "root",
|
|
5324
5962
|
"description": "A Group Type defines the semantics of [group assignments](#group).\nWhat the Group Type means and how it is to be used correctly SHOULD be described in the `description` (which may include markdown links).\n\nGroup Types can be defined centrally (ownership by authority namespace) or decentrally (defined by application / service itself).\n\nTo learn more about the concept, see [Group Concept Documentation](../concepts/grouping-and-bundling#groups).",
|
|
5325
5963
|
"x-introduced-in-version": "1.9.0",
|
|
5326
5964
|
"properties": {
|
|
@@ -5350,6 +5988,23 @@
|
|
|
5350
5988
|
"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"
|
|
5351
5989
|
]
|
|
5352
5990
|
},
|
|
5991
|
+
"labels": {
|
|
5992
|
+
"$ref": "#/definitions/Labels"
|
|
5993
|
+
},
|
|
5994
|
+
"correlationIds": {
|
|
5995
|
+
"type": "array",
|
|
5996
|
+
"description": "Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).\n\nThey express an \"identity\" / \"equals\" / \"mappable\" relationship to the target ID.\n\nIf a \"part of\" relationship needs to be expressed, use the `partOfGroups` assignment instead.\n\nMUST be a valid [Correlation ID](../index.md#correlation-id).",
|
|
5997
|
+
"items": {
|
|
5998
|
+
"type": "string",
|
|
5999
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6000
|
+
"maxLength": 255
|
|
6001
|
+
},
|
|
6002
|
+
"examples": [
|
|
6003
|
+
[
|
|
6004
|
+
"sap.s4:communicationScenario:SAP_COM_0008"
|
|
6005
|
+
]
|
|
6006
|
+
]
|
|
6007
|
+
},
|
|
5353
6008
|
"partOfGroupTypes": {
|
|
5354
6009
|
"type": "array",
|
|
5355
6010
|
"items": {
|
|
@@ -5377,6 +6032,7 @@
|
|
|
5377
6032
|
"Group": {
|
|
5378
6033
|
"title": "Group",
|
|
5379
6034
|
"type": "object",
|
|
6035
|
+
"x-ums-type": "root",
|
|
5380
6036
|
"description": "Group (instance) that resources can be assigned to.\n\nGroups are a lightweight custom taxonomy concept.\nThey express a \"part of\" relationship to the chosen group concept.\nIf an \"identity / equals\" relationship needs to be expressed, use the `correlationIds` instead.\n\nTo learn more about the concept, see [Group Concept Documentation](../concepts/grouping-and-bundling#groups).",
|
|
5381
6037
|
"x-introduced-in-version": "1.9.0",
|
|
5382
6038
|
"properties": {
|
|
@@ -5417,6 +6073,23 @@
|
|
|
5417
6073
|
"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"
|
|
5418
6074
|
]
|
|
5419
6075
|
},
|
|
6076
|
+
"labels": {
|
|
6077
|
+
"$ref": "#/definitions/Labels"
|
|
6078
|
+
},
|
|
6079
|
+
"correlationIds": {
|
|
6080
|
+
"type": "array",
|
|
6081
|
+
"description": "Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).\n\nThey express an \"identity\" / \"equals\" / \"mappable\" relationship to the target ID.\n\nIf a \"part of\" relationship needs to be expressed, use the `partOfGroups` assignment instead.\n\nMUST be a valid [Correlation ID](../index.md#correlation-id).",
|
|
6082
|
+
"items": {
|
|
6083
|
+
"type": "string",
|
|
6084
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
|
|
6085
|
+
"maxLength": 255
|
|
6086
|
+
},
|
|
6087
|
+
"examples": [
|
|
6088
|
+
[
|
|
6089
|
+
"sap.s4:communicationScenario:SAP_COM_0008"
|
|
6090
|
+
]
|
|
6091
|
+
]
|
|
6092
|
+
},
|
|
5420
6093
|
"partOfGroups": {
|
|
5421
6094
|
"type": "array",
|
|
5422
6095
|
"items": {
|
|
@@ -5449,6 +6122,7 @@
|
|
|
5449
6122
|
"type": "object",
|
|
5450
6123
|
"description": "Generic documentation 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 [CommonMark](https://spec.commonmark.org/) (Markdown) text.\n\nDocumentation Labels can be used to attach human readable documentation that cannot be expressed natively in ORD.\nA documentation tool (like an API Catalog) can use the documentation labels to provide generic documentation \"snippets\".\nDue to the given structure they can be displayed e.g. as tables.\n\nThe key of the documentation Label is plain-text (MUST not contain line breaks) and denotes the subject matter that is described.\nThe values (multiple can be provided for the same key) are [CommonMark](https://spec.commonmark.org/) (Markdown) text\nwhich describes the subject matter or lists options for the key.\n\nIn contrast to regular labels, documentation labels are not meant to be used to categorize or query information.",
|
|
5451
6124
|
"x-introduced-in-version": "1.1.0",
|
|
6125
|
+
"x-ums-type": "custom",
|
|
5452
6126
|
"patternProperties": {
|
|
5453
6127
|
"^.*$": {
|
|
5454
6128
|
"type": "array",
|
|
@@ -5469,6 +6143,7 @@
|
|
|
5469
6143
|
"Extensible": {
|
|
5470
6144
|
"title": "Extensible",
|
|
5471
6145
|
"type": "object",
|
|
6146
|
+
"x-ums-type": "embedded",
|
|
5472
6147
|
"description": "Contains information about the extensibility of this resource.\n\nIf applicable, a description and further resources about extending this resource are provided.",
|
|
5473
6148
|
"properties": {
|
|
5474
6149
|
"supported": {
|
|
@@ -5504,6 +6179,7 @@
|
|
|
5504
6179
|
"title": "Entity Type Mapping",
|
|
5505
6180
|
"type": "object",
|
|
5506
6181
|
"x-introduced-in-version": "1.6.0",
|
|
6182
|
+
"x-ums-type": "custom",
|
|
5507
6183
|
"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.",
|
|
5508
6184
|
"properties": {
|
|
5509
6185
|
"apiModelSelectors": {
|
|
@@ -5541,9 +6217,74 @@
|
|
|
5541
6217
|
"entityTypeTargets"
|
|
5542
6218
|
]
|
|
5543
6219
|
},
|
|
6220
|
+
"ApiCompatibility": {
|
|
6221
|
+
"title": "API Compatibility",
|
|
6222
|
+
"x-introduced-in-version": "1.13.0",
|
|
6223
|
+
"x-ums-type": "embedded",
|
|
6224
|
+
"type": "object",
|
|
6225
|
+
"description": "Describes the compatibility of the API with other APIs. This can be used to express that an API is compatible with another API version.",
|
|
6226
|
+
"properties": {
|
|
6227
|
+
"ordId": {
|
|
6228
|
+
"type": "string",
|
|
6229
|
+
"description": "ORD ID of the APIResource that serves as contract that this resource is compatible with.\n\nMUST be a valid reference to an (usually external) [API Resource](#api-resource) ORD ID.",
|
|
6230
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6231
|
+
"maxLength": 255,
|
|
6232
|
+
"examples": [
|
|
6233
|
+
"sap.s4:apiResource:API_BILL_OF_MATERIAL_SRV:v1"
|
|
6234
|
+
]
|
|
6235
|
+
},
|
|
6236
|
+
"maxVersion": {
|
|
6237
|
+
"type": "string",
|
|
6238
|
+
"description": "Specifies the maximum version of the interface contract that this resource is compatible with. This is the version, that the resource fully implements and supports.\n\nEven if the interface contract evolves compatible, this resource will not be compatible with versions beyond the specified one. It is important to consider, given the example of an API version 1.0, that has the fields A and B.\nBeing compatible with version 1.0 means to have exactly the fields A and B and potential tenant specific extensions in a dedicated namespace.\nIf an API contract changes to version 1.1 compatible by adding field C, the API declaring compatibility towards 1.0, will miss field C. Only if adopting the contract of 1.1 with having fields A, B, and C, such an API is also\ncompatible with version 1.1 of the contract. However, a client relying on version 1.0 of the contract, can still work with the API being compatible with version 1.1 of the contract.\n\nFollowing the [Semantic Versioning 2.0.0](https://semver.org/) standard, patch versions (x.y.Z) must not have impact on the schema/contract. Therefore, the maxVersion are only the major.minor parts of a semantic version.",
|
|
6239
|
+
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
|
|
6240
|
+
"examples": [
|
|
6241
|
+
"1.2",
|
|
6242
|
+
"2.0"
|
|
6243
|
+
]
|
|
6244
|
+
}
|
|
6245
|
+
},
|
|
6246
|
+
"additionalProperties": false,
|
|
6247
|
+
"required": [
|
|
6248
|
+
"ordId",
|
|
6249
|
+
"maxVersion"
|
|
6250
|
+
]
|
|
6251
|
+
},
|
|
6252
|
+
"EventCompatibility": {
|
|
6253
|
+
"title": "Event Compatibility",
|
|
6254
|
+
"x-introduced-in-version": "1.13.0",
|
|
6255
|
+
"x-ums-type": "embedded",
|
|
6256
|
+
"type": "object",
|
|
6257
|
+
"description": "Describes the compatibility of the Event with other Events. This can be used to express that an Event is compatible with another Event version.",
|
|
6258
|
+
"properties": {
|
|
6259
|
+
"ordId": {
|
|
6260
|
+
"type": "string",
|
|
6261
|
+
"description": "ORD ID of the EventResource that serves as contract that this resource is compatible with.\n\nMUST be a valid reference to an (usually external) [Event Resource](#event-resource) ORD ID.",
|
|
6262
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(eventResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6263
|
+
"maxLength": 255,
|
|
6264
|
+
"examples": [
|
|
6265
|
+
"sap.s4:eventResource:BillofMaterialEvents:v1"
|
|
6266
|
+
]
|
|
6267
|
+
},
|
|
6268
|
+
"maxVersion": {
|
|
6269
|
+
"type": "string",
|
|
6270
|
+
"description": "Specifies the maximum version of the interface contract that this resource is compatible with. This is the version, that the resource fully implements and supports.\n\nEven if the interface contract evolves compatible, this resource will not be compatible with versions beyond the specified one. It is important to consider, given the example of an event version 1.0, that has the fields A and B. Being compatible with version 1.0 means to have exactly the fields A and B and potential tenant specific extensions in a dedicated namespace.\nIf an event contract changes to version 1.1 compatible by adding field C, the event declaring compatibility towards 1.0, will miss field C. Only if adopting the contract of 1.1 with having fields A, B, and C, such an event is also\ncompatible with version 1.1 of the contract. However, a client relying on version 1.0 of the contract, can still work with the event being compatible with version 1.1 of the contract.\n\nFollowing the [Semantic Versioning 2.0.0](https://semver.org/) standard, patch versions (x.y.Z) must not have impact on the schema/contract. Therefore, the maxVersion are only the major.minor parts of a semantic version.",
|
|
6271
|
+
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$",
|
|
6272
|
+
"examples": [
|
|
6273
|
+
"1.2",
|
|
6274
|
+
"2.0"
|
|
6275
|
+
]
|
|
6276
|
+
}
|
|
6277
|
+
},
|
|
6278
|
+
"additionalProperties": false,
|
|
6279
|
+
"required": [
|
|
6280
|
+
"ordId",
|
|
6281
|
+
"maxVersion"
|
|
6282
|
+
]
|
|
6283
|
+
},
|
|
5544
6284
|
"ApiModelSelectorOData": {
|
|
5545
6285
|
"title": "Api Model Selector (Odata)",
|
|
5546
6286
|
"x-introduced-in-version": "1.6.0",
|
|
6287
|
+
"x-ums-type": "custom",
|
|
5547
6288
|
"type": "object",
|
|
5548
6289
|
"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`.",
|
|
5549
6290
|
"properties": {
|
|
@@ -5578,6 +6319,7 @@
|
|
|
5578
6319
|
"ApiModelSelectorJsonPointer": {
|
|
5579
6320
|
"title": "Api Model Selector (Json Pointer)",
|
|
5580
6321
|
"x-introduced-in-version": "1.6.0",
|
|
6322
|
+
"x-ums-type": "custom",
|
|
5581
6323
|
"type": "object",
|
|
5582
6324
|
"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`.",
|
|
5583
6325
|
"properties": {
|
|
@@ -5611,9 +6353,35 @@
|
|
|
5611
6353
|
}
|
|
5612
6354
|
]
|
|
5613
6355
|
},
|
|
6356
|
+
"ExposedApiResourcesTarget": {
|
|
6357
|
+
"title": "Exposed API Resource",
|
|
6358
|
+
"x-introduced-in-version": "1.14.0",
|
|
6359
|
+
"x-ums-type": "embedded",
|
|
6360
|
+
"type": "object",
|
|
6361
|
+
"description": "Reference to an API Resource that exposes the functionality of an agent.\n\nThis is a complex object to allow additional properties / selections to be attached in the future.",
|
|
6362
|
+
"properties": {
|
|
6363
|
+
"ordId": {
|
|
6364
|
+
"type": "string",
|
|
6365
|
+
"description": "The API Resource ORD ID that this reference points to.\n\nMUST be a valid reference to an [API Resource](#api-resource) ORD ID.",
|
|
6366
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
6367
|
+
"maxLength": 255,
|
|
6368
|
+
"examples": [
|
|
6369
|
+
"sap.foo:apiResource:DisputeResolutionAgent:v1"
|
|
6370
|
+
],
|
|
6371
|
+
"x-association-target": [
|
|
6372
|
+
"#/definitions/ApiResource/ordId"
|
|
6373
|
+
]
|
|
6374
|
+
}
|
|
6375
|
+
},
|
|
6376
|
+
"required": [
|
|
6377
|
+
"ordId"
|
|
6378
|
+
],
|
|
6379
|
+
"additionalProperties": false
|
|
6380
|
+
},
|
|
5614
6381
|
"EntityTypeOrdIdTarget": {
|
|
5615
|
-
"title": "Entity Type Target (
|
|
6382
|
+
"title": "Entity Type Target (ORD ID)",
|
|
5616
6383
|
"x-introduced-in-version": "1.6.0",
|
|
6384
|
+
"x-ums-type": "custom",
|
|
5617
6385
|
"type": "object",
|
|
5618
6386
|
"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.",
|
|
5619
6387
|
"properties": {
|
|
@@ -5640,6 +6408,7 @@
|
|
|
5640
6408
|
"type": "object",
|
|
5641
6409
|
"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).",
|
|
5642
6410
|
"x-introduced-in-version": "1.6.0",
|
|
6411
|
+
"x-ums-type": "custom",
|
|
5643
6412
|
"properties": {
|
|
5644
6413
|
"correlationId": {
|
|
5645
6414
|
"type": "string",
|
|
@@ -5658,6 +6427,7 @@
|
|
|
5658
6427
|
"RelatedEntityType": {
|
|
5659
6428
|
"title": "Related Entity Type",
|
|
5660
6429
|
"x-introduced-in-version": "1.9.0",
|
|
6430
|
+
"x-ums-type": "embedded",
|
|
5661
6431
|
"type": "object",
|
|
5662
6432
|
"description": "Defines the relation between Entity Types (via its ORD ID).",
|
|
5663
6433
|
"properties": {
|
|
@@ -5703,6 +6473,7 @@
|
|
|
5703
6473
|
"type": "object",
|
|
5704
6474
|
"description": "Defines which Entity Type is exposed through (via its ORD ID).",
|
|
5705
6475
|
"x-introduced-in-version": "1.11.0",
|
|
6476
|
+
"x-ums-type": "embedded",
|
|
5706
6477
|
"properties": {
|
|
5707
6478
|
"ordId": {
|
|
5708
6479
|
"type": "string",
|
|
@@ -5725,12 +6496,13 @@
|
|
|
5725
6496
|
"Tombstone": {
|
|
5726
6497
|
"type": "object",
|
|
5727
6498
|
"title": "Tombstone",
|
|
6499
|
+
"x-ums-type": "ignore",
|
|
5728
6500
|
"description": "A tombstone indicates that a previously published ORD resource or taxonomy has been removed / decommissioned / archived.\nThis MUST be indicated explicitly, so ORD aggregators and consumers can learn about the removal.\n\nExactly one of the IDs MUST be provided to state which ORD resource or taxonomy item the Tombstone addresses.\n\nThe tombstone MUST be kept sufficiently long (at least 31 days) so that all ORD aggregators can learn about the tombstone.",
|
|
5729
6501
|
"properties": {
|
|
5730
6502
|
"ordId": {
|
|
5731
6503
|
"type": "string",
|
|
5732
6504
|
"description": "[ORD ID](../index.md#ord-id) of the ORD resource/taxonomy that has been removed.",
|
|
5733
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(package|consumptionBundle|product|vendor|apiResource|eventResource|capability|entityType|integrationDependency|dataProduct):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*|)?$",
|
|
6505
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(package|consumptionBundle|product|vendor|apiResource|eventResource|capability|entityType|integrationDependency|dataProduct|agent):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*|)?$",
|
|
5734
6506
|
"maxLength": 255,
|
|
5735
6507
|
"examples": [
|
|
5736
6508
|
"sap.xref:package:SomePackage:v1"
|
|
@@ -5745,7 +6517,8 @@
|
|
|
5745
6517
|
"#/definitions/Capability/ordId",
|
|
5746
6518
|
"#/definitions/EntityType/ordId",
|
|
5747
6519
|
"#/definitions/IntegrationDependency/ordId",
|
|
5748
|
-
"#/definitions/DataProduct/ordId"
|
|
6520
|
+
"#/definitions/DataProduct/ordId",
|
|
6521
|
+
"#/definitions/Agent/ordId"
|
|
5749
6522
|
]
|
|
5750
6523
|
},
|
|
5751
6524
|
"groupId": {
|
|
@@ -5805,12 +6578,13 @@
|
|
|
5805
6578
|
"OrdResource": {
|
|
5806
6579
|
"type": "object",
|
|
5807
6580
|
"title": "Ord Resource (abstract)",
|
|
6581
|
+
"x-ums-type": "root",
|
|
5808
6582
|
"description": "Abstract definition of shared properties across ORD Resources.",
|
|
5809
6583
|
"properties": {
|
|
5810
6584
|
"ordId": {
|
|
5811
6585
|
"type": "string",
|
|
5812
6586
|
"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.",
|
|
5813
|
-
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource|eventResource|capability|dataProduct):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*|)$",
|
|
6587
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(apiResource|eventResource|capability|dataProduct|agent):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*|)$",
|
|
5814
6588
|
"maxLength": 255,
|
|
5815
6589
|
"examples": []
|
|
5816
6590
|
},
|