@open-resource-discovery/specification 1.10.0 → 1.10.1

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.
@@ -2,6 +2,7 @@
2
2
  "description": "The [ORD Document](../index.md#ord-document) object serves as a wrapper for the **ORD resources** and **ORD taxonomy** and adds further top-level information\nthat are specific to the document/the service it describes.\n\nThe constraints and considerations on [ORD Documents](../index.md#ord-document) MUST be followed.",
3
3
  "$schema": "http://json-schema.org/draft-07/schema#",
4
4
  "$id": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json#",
5
+ "title": "ORD Document",
5
6
  "x-property-order": [
6
7
  "Document",
7
8
  "ApiResource",
@@ -22,6 +23,7 @@
22
23
  "Package": {
23
24
  "type": "object",
24
25
  "title": "Package",
26
+ "x-ums-type": "root",
25
27
  "description": "A [**Package**](../../details/articles/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](../../details/articles/grouping-and-bundling#package).",
26
28
  "properties": {
27
29
  "ordId": {
@@ -36,7 +38,7 @@
36
38
  "localId": {
37
39
  "type": "string",
38
40
  "x-introduced-in-version": "1.2.1",
39
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
41
+ "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.",
40
42
  "maxLength": 255,
41
43
  "examples": [
42
44
  "SuccessFactorsRecruiting",
@@ -177,7 +179,7 @@
177
179
  },
178
180
  "partOfProducts": {
179
181
  "type": "array",
180
- "description": "List of products this resource is 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.",
182
+ "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.",
181
183
  "items": {
182
184
  "type": "string",
183
185
  "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
@@ -420,6 +422,7 @@
420
422
  "ConsumptionBundle": {
421
423
  "type": "object",
422
424
  "title": "Consumption Bundle",
425
+ "x-ums-type": "root",
423
426
  "description": "A [**Consumption Bundle**](../../details/articles/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](../../details/articles/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](../../details/articles/grouping-and-bundling#consumption-bundle).",
424
427
  "properties": {
425
428
  "ordId": {
@@ -434,7 +437,7 @@
434
437
  "localId": {
435
438
  "type": "string",
436
439
  "x-introduced-in-version": "1.2.1",
437
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
440
+ "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.",
438
441
  "maxLength": 255,
439
442
  "examples": [
440
443
  "SuccessFactorsRecruiting",
@@ -570,6 +573,7 @@
570
573
  "ConsumptionBundleReference": {
571
574
  "type": "object",
572
575
  "title": "Consumption Bundle Reference",
576
+ "x-ums-type": "embedded",
573
577
  "description": "Reference to a Consumption bundle.\n\nThis is a complex object to allow additional properties / selections to be attached.",
574
578
  "properties": {
575
579
  "ordId": {
@@ -598,6 +602,8 @@
598
602
  "ApiResource": {
599
603
  "type": "object",
600
604
  "title": "API Resource",
605
+ "x-ums-type": "root",
606
+ "x-implements": "#/definitions/OrdResource",
601
607
  "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.",
602
608
  "properties": {
603
609
  "ordId": {
@@ -612,7 +618,7 @@
612
618
  "localId": {
613
619
  "type": "string",
614
620
  "x-introduced-in-version": "1.2.1",
615
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
621
+ "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.",
616
622
  "maxLength": 255,
617
623
  "examples": [
618
624
  "API_BILL_OF_MATERIAL_SRV"
@@ -664,6 +670,12 @@
664
670
  "x-association-target": [
665
671
  "#/definitions/Package/ordId"
666
672
  ],
673
+ "x-reverse-relationship": {
674
+ "propertyName": "apiResources",
675
+ "description": "The API resources that are part the given Package.",
676
+ "min": 0,
677
+ "max": "*"
678
+ },
667
679
  "maxLength": 255,
668
680
  "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.",
669
681
  "examples": [
@@ -679,6 +691,12 @@
679
691
  "#/definitions/Group/groupId"
680
692
  ]
681
693
  },
694
+ "x-reverse-relationship": {
695
+ "propertyName": "apiResourceMembers",
696
+ "description": "The API resources that are part the given Group.",
697
+ "min": 0,
698
+ "max": "*"
699
+ },
682
700
  "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."
683
701
  },
684
702
  "partOfConsumptionBundles": {
@@ -709,7 +727,7 @@
709
727
  },
710
728
  "partOfProducts": {
711
729
  "type": "array",
712
- "description": "List of products this resource is 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.",
730
+ "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.",
713
731
  "items": {
714
732
  "type": "string",
715
733
  "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
@@ -932,7 +950,7 @@
932
950
  "oneOf": [
933
951
  {
934
952
  "const": "sap:ord-document-api:v1",
935
- "description": "API follows the Open Resource Discovery v1 [Document API](../index.md#ord-document-api) contract."
953
+ "description": "API follows the Open Resource Discovery v1 [Document API](../index.md#ord-provider-api) contract."
936
954
  },
937
955
  {
938
956
  "const": "cff:open-service-broker:v2",
@@ -1375,6 +1393,8 @@
1375
1393
  "EventResource": {
1376
1394
  "type": "object",
1377
1395
  "title": "Event Resource",
1396
+ "x-ums-type": "root",
1397
+ "x-implements": "#/definitions/OrdResource",
1378
1398
  "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.",
1379
1399
  "properties": {
1380
1400
  "ordId": {
@@ -1390,7 +1410,7 @@
1390
1410
  "localId": {
1391
1411
  "type": "string",
1392
1412
  "x-introduced-in-version": "1.2.1",
1393
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
1413
+ "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.",
1394
1414
  "maxLength": 255,
1395
1415
  "examples": [
1396
1416
  "BusinessEvents_SubscriptionEvents"
@@ -1443,6 +1463,12 @@
1443
1463
  "x-association-target": [
1444
1464
  "#/definitions/Package/ordId"
1445
1465
  ],
1466
+ "x-reverse-relationship": {
1467
+ "propertyName": "eventResources",
1468
+ "description": "The event resources that are part the given Package.",
1469
+ "min": 0,
1470
+ "max": "*"
1471
+ },
1446
1472
  "maxLength": 255,
1447
1473
  "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.",
1448
1474
  "examples": [
@@ -1458,6 +1484,10 @@
1458
1484
  "#/definitions/Group/groupId"
1459
1485
  ]
1460
1486
  },
1487
+ "x-reverse-relationship": {
1488
+ "propertyName": "eventResourceMembers",
1489
+ "description": "The event resources that are part the given Group."
1490
+ },
1461
1491
  "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."
1462
1492
  },
1463
1493
  "partOfConsumptionBundles": {
@@ -1488,7 +1518,7 @@
1488
1518
  },
1489
1519
  "partOfProducts": {
1490
1520
  "type": "array",
1491
- "description": "List of products this resource is 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.",
1521
+ "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.",
1492
1522
  "items": {
1493
1523
  "type": "string",
1494
1524
  "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
@@ -1984,6 +2014,7 @@
1984
2014
  "EntityType": {
1985
2015
  "type": "object",
1986
2016
  "title": "Entity Type",
2017
+ "x-ums-type": "root",
1987
2018
  "description": "An [**Entity Type**](../../details/articles/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](../../details/articles/grouping-and-bundling#entity-type).",
1988
2019
  "x-introduced-in-version": "1.8.0",
1989
2020
  "properties": {
@@ -2001,7 +2032,7 @@
2001
2032
  "localId": {
2002
2033
  "type": "string",
2003
2034
  "x-introduced-in-version": "1.2.1",
2004
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
2035
+ "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.",
2005
2036
  "maxLength": 255,
2006
2037
  "examples": [
2007
2038
  "BusinessPartner",
@@ -2067,6 +2098,12 @@
2067
2098
  "x-association-target": [
2068
2099
  "#/definitions/Package/ordId"
2069
2100
  ],
2101
+ "x-reverse-relationship": {
2102
+ "propertyName": "entityTypes",
2103
+ "description": "The entity types that are part the given Package.",
2104
+ "min": 0,
2105
+ "max": "*"
2106
+ },
2070
2107
  "maxLength": 255,
2071
2108
  "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.",
2072
2109
  "examples": [
@@ -2082,11 +2119,15 @@
2082
2119
  "#/definitions/Group/groupId"
2083
2120
  ]
2084
2121
  },
2122
+ "x-reverse-relationship": {
2123
+ "propertyName": "entityTypeMembers",
2124
+ "description": "The entity types that are part the given Group."
2125
+ },
2085
2126
  "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."
2086
2127
  },
2087
2128
  "partOfProducts": {
2088
2129
  "type": "array",
2089
- "description": "List of products this resource is 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.",
2130
+ "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.",
2090
2131
  "items": {
2091
2132
  "type": "string",
2092
2133
  "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
@@ -2353,7 +2394,9 @@
2353
2394
  "DataProduct": {
2354
2395
  "type": "object",
2355
2396
  "title": "Data Product",
2397
+ "x-ums-type": "root",
2356
2398
  "x-introduced-in-version": "1.8.0",
2399
+ "x-implements": "#/definitions/OrdResource",
2357
2400
  "description": "A [Data Product](../../details/articles/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 - Beta Status](../../details/articles/data-product#beta-status).",
2358
2401
  "properties": {
2359
2402
  "ordId": {
@@ -2368,7 +2411,7 @@
2368
2411
  "localId": {
2369
2412
  "type": "string",
2370
2413
  "x-introduced-in-version": "1.2.1",
2371
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
2414
+ "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.",
2372
2415
  "maxLength": 255,
2373
2416
  "examples": [
2374
2417
  "CustomerOrder"
@@ -2421,6 +2464,12 @@
2421
2464
  "x-association-target": [
2422
2465
  "#/definitions/Package/ordId"
2423
2466
  ],
2467
+ "x-reverse-relationship": {
2468
+ "propertyName": "dataProducts",
2469
+ "description": "The data products that are part the given Package.",
2470
+ "min": 0,
2471
+ "max": "*"
2472
+ },
2424
2473
  "maxLength": 255,
2425
2474
  "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.",
2426
2475
  "examples": [
@@ -2428,7 +2477,6 @@
2428
2477
  ]
2429
2478
  },
2430
2479
  "partOfGroups": {
2431
- "x-feature-status": "beta",
2432
2480
  "type": "array",
2433
2481
  "items": {
2434
2482
  "type": "string",
@@ -2437,7 +2485,30 @@
2437
2485
  "#/definitions/Group/groupId"
2438
2486
  ]
2439
2487
  },
2440
- "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."
2488
+ "x-reverse-relationship": {
2489
+ "propertyName": "dataProductMembers",
2490
+ "description": "The data products that are part the given Group."
2491
+ },
2492
+ "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.",
2493
+ "x-feature-status": "beta"
2494
+ },
2495
+ "partOfProducts": {
2496
+ "type": "array",
2497
+ "description": "List of products this Data Product is a part of or is related to, its e.g. data source systems.\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.",
2498
+ "items": {
2499
+ "type": "string",
2500
+ "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\\-]+):()$",
2501
+ "maxLength": 255,
2502
+ "x-association-target": [
2503
+ "#/definitions/Product/ordId"
2504
+ ]
2505
+ },
2506
+ "minItems": 0,
2507
+ "examples": [
2508
+ [
2509
+ "sap:product:S4HANA_OD:"
2510
+ ]
2511
+ ]
2441
2512
  },
2442
2513
  "version": {
2443
2514
  "type": "string",
@@ -2638,6 +2709,12 @@
2638
2709
  "#/definitions/EntityType/ordId"
2639
2710
  ]
2640
2711
  },
2712
+ "x-reverse-relationship": {
2713
+ "propertyName": "dataProducts",
2714
+ "description": "Data Products associated to the Entity Type.",
2715
+ "min": 0,
2716
+ "max": "*"
2717
+ },
2641
2718
  "examples": [
2642
2719
  [
2643
2720
  "sap.odm:entityType:CustomerOrder:v1",
@@ -3006,6 +3083,7 @@
3006
3083
  "DataProductInputPort": {
3007
3084
  "type": "object",
3008
3085
  "title": "Data Product Input Port",
3086
+ "x-ums-type": "embedded",
3009
3087
  "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.",
3010
3088
  "properties": {
3011
3089
  "ordId": {
@@ -3029,6 +3107,7 @@
3029
3107
  "DataProductOutputPort": {
3030
3108
  "type": "object",
3031
3109
  "title": "Data Product Output Port",
3110
+ "x-ums-type": "embedded",
3032
3111
  "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.",
3033
3112
  "properties": {
3034
3113
  "ordId": {
@@ -3055,6 +3134,7 @@
3055
3134
  "type": "object",
3056
3135
  "title": "API Resource Definition",
3057
3136
  "description": "Link and categorization of a machine-readable API definition.\nFor example, OpenAPI definition, OData Metadata, etc.",
3137
+ "x-ums-type": "custom",
3058
3138
  "properties": {
3059
3139
  "type": {
3060
3140
  "description": "Type of the API Resource Definition\nIf \"custom\" is chosen, a customType MUST be provided",
@@ -3185,6 +3265,7 @@
3185
3265
  "EventResourceDefinition": {
3186
3266
  "type": "object",
3187
3267
  "title": "Event Resource Definition",
3268
+ "x-ums-type": "custom",
3188
3269
  "description": "Link and categorization of a machine-readable API definition.\nFor example, AsyncAPI or OpenAPI with callbacks, etc.",
3189
3270
  "properties": {
3190
3271
  "type": {
@@ -3277,6 +3358,7 @@
3277
3358
  "Product": {
3278
3359
  "type": "object",
3279
3360
  "title": "Product",
3361
+ "x-ums-type": "root",
3280
3362
  "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.",
3281
3363
  "properties": {
3282
3364
  "ordId": {
@@ -3386,7 +3468,9 @@
3386
3468
  "Capability": {
3387
3469
  "type": "object",
3388
3470
  "title": "Capability",
3471
+ "x-ums-type": "root",
3389
3472
  "x-introduced-in-version": "1.4.0",
3473
+ "x-implements": "#/definitions/OrdResource",
3390
3474
  "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.",
3391
3475
  "properties": {
3392
3476
  "ordId": {
@@ -3401,7 +3485,7 @@
3401
3485
  "localId": {
3402
3486
  "type": "string",
3403
3487
  "x-introduced-in-version": "1.2.1",
3404
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
3488
+ "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.",
3405
3489
  "maxLength": 255,
3406
3490
  "examples": [
3407
3491
  "SuccessFactorsRecruiting",
@@ -3480,6 +3564,12 @@
3480
3564
  "x-association-target": [
3481
3565
  "#/definitions/Package/ordId"
3482
3566
  ],
3567
+ "x-reverse-relationship": {
3568
+ "propertyName": "capabilities",
3569
+ "description": "The capabilities that are part the given Package.",
3570
+ "min": 0,
3571
+ "max": "*"
3572
+ },
3483
3573
  "maxLength": 255,
3484
3574
  "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.",
3485
3575
  "examples": [
@@ -3495,6 +3585,10 @@
3495
3585
  "#/definitions/Group/groupId"
3496
3586
  ]
3497
3587
  },
3588
+ "x-reverse-relationship": {
3589
+ "propertyName": "capabilityMembers",
3590
+ "description": "The Capabilities that are part the given Group."
3591
+ },
3498
3592
  "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."
3499
3593
  },
3500
3594
  "version": {
@@ -3573,6 +3667,12 @@
3573
3667
  "#/definitions/EntityType/ordId"
3574
3668
  ]
3575
3669
  },
3670
+ "x-reverse-relationship": {
3671
+ "propertyName": "capabilities",
3672
+ "description": "Capabilities associated to the Entity Type.",
3673
+ "min": 0,
3674
+ "max": "*"
3675
+ },
3576
3676
  "examples": [
3577
3677
  [
3578
3678
  "sap.odm:entityType:WorkforcePerson:v1"
@@ -3643,6 +3743,7 @@
3643
3743
  "type": "object",
3644
3744
  "title": "Capability Definition",
3645
3745
  "x-introduced-in-version": "1.4.0",
3746
+ "x-ums-type": "custom",
3646
3747
  "description": "Link and categorization of a machine-readable capability definition.",
3647
3748
  "properties": {
3648
3749
  "type": {
@@ -3731,6 +3832,7 @@
3731
3832
  "IntegrationDependency": {
3732
3833
  "type": "object",
3733
3834
  "title": "Integration Dependency",
3835
+ "x-ums-type": "root",
3734
3836
  "x-introduced-in-version": "1.7.0",
3735
3837
  "description": "An [Integration Dependency](../../details/articles/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](../../details/articles/integration-dependency).",
3736
3838
  "properties": {
@@ -3746,7 +3848,7 @@
3746
3848
  "localId": {
3747
3849
  "type": "string",
3748
3850
  "x-introduced-in-version": "1.2.1",
3749
- "description": "Local ID, as known by the described system.\n\nThis can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.",
3851
+ "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.",
3750
3852
  "maxLength": 255,
3751
3853
  "examples": [
3752
3854
  "SuccessFactorsRecruiting",
@@ -3799,6 +3901,12 @@
3799
3901
  "x-association-target": [
3800
3902
  "#/definitions/Package/ordId"
3801
3903
  ],
3904
+ "x-reverse-relationship": {
3905
+ "propertyName": "integrationDependencies",
3906
+ "description": "The integration dependencies that are part the given Package.",
3907
+ "min": 0,
3908
+ "max": "*"
3909
+ },
3802
3910
  "maxLength": 255,
3803
3911
  "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.",
3804
3912
  "examples": [
@@ -3814,6 +3922,10 @@
3814
3922
  "#/definitions/Group/groupId"
3815
3923
  ]
3816
3924
  },
3925
+ "x-reverse-relationship": {
3926
+ "propertyName": "integrationDependencyMembers",
3927
+ "description": "The Integration Dependencies that are part the given Group."
3928
+ },
3817
3929
  "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."
3818
3930
  },
3819
3931
  "version": {
@@ -3971,6 +4083,7 @@
3971
4083
  "type": "object",
3972
4084
  "title": "Aspect",
3973
4085
  "x-introduced-in-version": "1.7.0",
4086
+ "x-ums-type": "custom",
3974
4087
  "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.",
3975
4088
  "properties": {
3976
4089
  "title": {
@@ -4023,6 +4136,7 @@
4023
4136
  "type": "object",
4024
4137
  "title": "API Resource Integration Aspect",
4025
4138
  "x-introduced-in-version": "1.7.0",
4139
+ "x-ums-type": "custom",
4026
4140
  "description": "API resource related integration aspect",
4027
4141
  "properties": {
4028
4142
  "ordId": {
@@ -4053,6 +4167,7 @@
4053
4167
  "type": "object",
4054
4168
  "title": "Event Resource Integration Aspect",
4055
4169
  "x-introduced-in-version": "1.7.0",
4170
+ "x-ums-type": "custom",
4056
4171
  "description": "Event resource related integration aspect",
4057
4172
  "properties": {
4058
4173
  "ordId": {
@@ -4105,6 +4220,7 @@
4105
4220
  "type": "object",
4106
4221
  "title": "Event Resource Integration Aspect Subset",
4107
4222
  "x-introduced-in-version": "1.7.0",
4223
+ "x-ums-type": "custom",
4108
4224
  "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.",
4109
4225
  "properties": {
4110
4226
  "eventType": {
@@ -4123,6 +4239,7 @@
4123
4239
  "Vendor": {
4124
4240
  "type": "object",
4125
4241
  "title": "Vendor",
4242
+ "x-ums-type": "root",
4126
4243
  "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:`.",
4127
4244
  "properties": {
4128
4245
  "ordId": {
@@ -4195,6 +4312,7 @@
4195
4312
  "type": "object",
4196
4313
  "title": "Changelog Entry",
4197
4314
  "description": "A changelog entry can be used to indicate changes.\nUsually they lead to a change of the version number or the release status.",
4315
+ "x-ums-type": "custom",
4198
4316
  "properties": {
4199
4317
  "version": {
4200
4318
  "type": "string",
@@ -4258,6 +4376,7 @@
4258
4376
  "type": "object",
4259
4377
  "title": "Link",
4260
4378
  "description": "Link that can be attached to packages or Open Resource Discovery resources.\n",
4379
+ "x-ums-type": "custom",
4261
4380
  "properties": {
4262
4381
  "title": {
4263
4382
  "type": "string",
@@ -4299,6 +4418,7 @@
4299
4418
  "PackageLink": {
4300
4419
  "type": "object",
4301
4420
  "title": "Package Link",
4421
+ "x-ums-type": "custom",
4302
4422
  "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.",
4303
4423
  "properties": {
4304
4424
  "type": {
@@ -4373,6 +4493,7 @@
4373
4493
  "APIEventResourceLink": {
4374
4494
  "type": "object",
4375
4495
  "title": "API and Event Resource Link",
4496
+ "x-ums-type": "custom",
4376
4497
  "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.",
4377
4498
  "properties": {
4378
4499
  "type": {
@@ -4450,6 +4571,7 @@
4450
4571
  "DataProductLink": {
4451
4572
  "type": "object",
4452
4573
  "title": "Data Product Link",
4574
+ "x-ums-type": "custom",
4453
4575
  "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.",
4454
4576
  "properties": {
4455
4577
  "type": {
@@ -4513,6 +4635,7 @@
4513
4635
  "SystemInstance": {
4514
4636
  "type": "object",
4515
4637
  "title": "System Instance",
4638
+ "x-ums-type": "ignore",
4516
4639
  "description": "A [system instance](../index.md#def-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#def-system-deployment) itself.",
4517
4640
  "properties": {
4518
4641
  "baseUrl": {
@@ -4579,6 +4702,7 @@
4579
4702
  "type": "object",
4580
4703
  "title": "System Type",
4581
4704
  "description": "A [system type](../index.md#def-system-type) is the abstract type of an application or service, from operational perspective.",
4705
+ "x-ums-type": "ignore",
4582
4706
  "properties": {
4583
4707
  "systemNamespace": {
4584
4708
  "type": "string",
@@ -4634,6 +4758,7 @@
4634
4758
  "type": "object",
4635
4759
  "title": "System Version",
4636
4760
  "description": "A [system version](../index.md#def-system-version) states the design-time version / release of a [system instance](../index.md#def-system-instance).\nIt provides versioning for operational purposes for the [system type](../index.md#def-system-type).",
4761
+ "x-ums-type": "ignore",
4637
4762
  "properties": {
4638
4763
  "version": {
4639
4764
  "type": "string",
@@ -4693,6 +4818,7 @@
4693
4818
  "type": "object",
4694
4819
  "title": "Access Strategy",
4695
4820
  "description": "Defines the [access strategy](../../spec-extensions/access-strategies/) for accessing the resource definitions.",
4821
+ "x-ums-type": "custom",
4696
4822
  "properties": {
4697
4823
  "type": {
4698
4824
  "type": "string",
@@ -4760,6 +4886,7 @@
4760
4886
  "type": "object",
4761
4887
  "title": "Credential Exchange Strategy",
4762
4888
  "x-feature-status": "alpha",
4889
+ "x-ums-type": "custom",
4763
4890
  "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.",
4764
4891
  "properties": {
4765
4892
  "type": {
@@ -4805,6 +4932,7 @@
4805
4932
  "title": "Labels",
4806
4933
  "type": "object",
4807
4934
  "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.",
4935
+ "x-ums-type": "custom",
4808
4936
  "patternProperties": {
4809
4937
  "^[a-zA-Z0-9-_.]*$": {
4810
4938
  "type": "array",
@@ -4826,6 +4954,7 @@
4826
4954
  "GroupType": {
4827
4955
  "title": "Group Type",
4828
4956
  "type": "object",
4957
+ "x-ums-type": "root",
4829
4958
  "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](../../details/articles/grouping-and-bundling#Groups).",
4830
4959
  "x-introduced-in-version": "1.9.0",
4831
4960
  "properties": {
@@ -4871,6 +5000,7 @@
4871
5000
  "Group": {
4872
5001
  "title": "Group",
4873
5002
  "type": "object",
5003
+ "x-ums-type": "root",
4874
5004
  "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](../../details/articles/grouping-and-bundling#Groups).",
4875
5005
  "x-introduced-in-version": "1.9.0",
4876
5006
  "properties": {
@@ -4892,7 +5022,13 @@
4892
5022
  ],
4893
5023
  "x-association-target": [
4894
5024
  "#/definitions/GroupType/groupTypeId"
4895
- ]
5025
+ ],
5026
+ "x-reverse-relationship": {
5027
+ "propertyName": "groups",
5028
+ "description": "Group instances of the group type.",
5029
+ "min": 0,
5030
+ "max": "*"
5031
+ }
4896
5032
  },
4897
5033
  "title": {
4898
5034
  "type": "string",
@@ -4930,6 +5066,7 @@
4930
5066
  "type": "object",
4931
5067
  "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.",
4932
5068
  "x-introduced-in-version": "1.1.0",
5069
+ "x-ums-type": "custom",
4933
5070
  "patternProperties": {
4934
5071
  "^.*$": {
4935
5072
  "type": "array",
@@ -4950,6 +5087,7 @@
4950
5087
  "Extensible": {
4951
5088
  "title": "Extensible",
4952
5089
  "type": "object",
5090
+ "x-ums-type": "embedded",
4953
5091
  "description": "Contains information about the extensibility of this resource.\n\nIf applicable, a description and further resources about extending this resource are provided.",
4954
5092
  "properties": {
4955
5093
  "supported": {
@@ -4984,8 +5122,9 @@
4984
5122
  "EntityTypeMapping": {
4985
5123
  "title": "Entity Type Mapping",
4986
5124
  "x-introduced-in-version": "1.6.0",
5125
+ "x-ums-type": "custom",
4987
5126
  "type": "object",
4988
- "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](../../#/v1/README?id=correlation-id)\nor to an [ORD ID](../../spec-v1/#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 navigatable for customers.",
5127
+ "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](../../#/v1/README?id=correlation-id)\nor to an [ORD ID](../../spec-v1/#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.",
4989
5128
  "properties": {
4990
5129
  "apiModelSelectors": {
4991
5130
  "type": "array",
@@ -5025,6 +5164,7 @@
5025
5164
  "ApiModelSelectorOData": {
5026
5165
  "title": "API Model Selector (OData)",
5027
5166
  "x-introduced-in-version": "1.6.0",
5167
+ "x-ums-type": "custom",
5028
5168
  "type": "object",
5029
5169
  "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`.",
5030
5170
  "properties": {
@@ -5059,6 +5199,7 @@
5059
5199
  "ApiModelSelectorJsonPointer": {
5060
5200
  "title": "API Model Selector (JSON Pointer)",
5061
5201
  "x-introduced-in-version": "1.6.0",
5202
+ "x-ums-type": "custom",
5062
5203
  "type": "object",
5063
5204
  "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`.",
5064
5205
  "properties": {
@@ -5095,6 +5236,7 @@
5095
5236
  "RelatedEntityType": {
5096
5237
  "title": "Related Entity Type",
5097
5238
  "x-introduced-in-version": "1.9.0",
5239
+ "x-ums-type": "embedded",
5098
5240
  "type": "object",
5099
5241
  "description": "Defines which Entity Type is related (via its ORD ID).\nIn the future, this could include stating the relationship type, too.",
5100
5242
  "properties": {
@@ -5119,6 +5261,7 @@
5119
5261
  "EntityTypeOrdIdTarget": {
5120
5262
  "title": "Entity Type Target (ORD ID)",
5121
5263
  "x-introduced-in-version": "1.6.0",
5264
+ "x-ums-type": "custom",
5122
5265
  "type": "object",
5123
5266
  "description": "Define which entity type is the target of an entity type mapping\n\nEntity types can be referenced using a [ORD ID](../../spec-v1/#ord-id) of an entity type.",
5124
5267
  "properties": {
@@ -5143,6 +5286,7 @@
5143
5286
  "EntityTypeCorrelationIdTarget": {
5144
5287
  "title": "Entity Type Target (Correlation ID)",
5145
5288
  "x-introduced-in-version": "1.6.0",
5289
+ "x-ums-type": "custom",
5146
5290
  "type": "object",
5147
5291
  "description": "Define which entity type is the target of an entity type mapping\n\nEntity types can be referenced using a [Correlation ID](../../spec-v1/#correlation-id).",
5148
5292
  "properties": {
@@ -5163,6 +5307,7 @@
5163
5307
  "Tombstone": {
5164
5308
  "type": "object",
5165
5309
  "title": "Tombstone",
5310
+ "x-ums-type": "ignore",
5166
5311
  "description": "A tombstone indicates that a previously published ORD resource or taxonomy has been removed / decommissioned.\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\nIt MUST be kept sufficiently long so that all ORD aggregators can learn about the tombstone.\nAfter that it MAY be removed.",
5167
5312
  "properties": {
5168
5313
  "ordId": {
@@ -5239,10 +5384,189 @@
5239
5384
  "removalDate": "2020-12-02T14:12:59Z"
5240
5385
  }
5241
5386
  ]
5387
+ },
5388
+ "OrdResource": {
5389
+ "type": "object",
5390
+ "title": "ORD Resource (abstract)",
5391
+ "x-abstract": true,
5392
+ "x-ums-type": "root",
5393
+ "description": "Abstract definition of shared properties across ORD Resources.",
5394
+ "properties": {
5395
+ "ordId": {
5396
+ "type": "string",
5397
+ "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.",
5398
+ "pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):(apiResource|eventResource|capability|dataProduct):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*|)$",
5399
+ "maxLength": 255,
5400
+ "examples": []
5401
+ },
5402
+ "localId": {
5403
+ "type": "string",
5404
+ "x-introduced-in-version": "1.2.1",
5405
+ "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.",
5406
+ "maxLength": 255,
5407
+ "examples": []
5408
+ },
5409
+ "correlationIds": {
5410
+ "type": "array",
5411
+ "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).",
5412
+ "items": {
5413
+ "type": "string",
5414
+ "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-\\/]+):([a-zA-Z0-9._\\-\\/]+)$",
5415
+ "maxLength": 255
5416
+ },
5417
+ "examples": []
5418
+ },
5419
+ "title": {
5420
+ "type": "string",
5421
+ "description": "Human-readable title.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
5422
+ "minLength": 1,
5423
+ "maxLength": 255,
5424
+ "examples": []
5425
+ },
5426
+ "shortDescription": {
5427
+ "type": "string",
5428
+ "description": "Plain text short description.\n\nMUST NOT exceed 255 chars.\nMUST NOT contain line breaks.",
5429
+ "minLength": 1,
5430
+ "maxLength": 255,
5431
+ "examples": []
5432
+ },
5433
+ "description": {
5434
+ "type": "string",
5435
+ "minLength": 1,
5436
+ "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.",
5437
+ "examples": []
5438
+ },
5439
+ "partOfPackage": {
5440
+ "type": "string",
5441
+ "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):(package):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
5442
+ "x-association-target": [
5443
+ "#/definitions/Package/ordId"
5444
+ ],
5445
+ "x-reverse-relationship": null,
5446
+ "maxLength": 255,
5447
+ "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.",
5448
+ "examples": []
5449
+ },
5450
+ "partOfGroups": {
5451
+ "type": "array",
5452
+ "items": {
5453
+ "type": "string",
5454
+ "pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):([a-zA-Z0-9._\\-\\/]+):([a-z0-9-]+(?:[.][a-z0-9-]+)*):([a-zA-Z0-9._\\-\\/]+)$",
5455
+ "x-association-target": [
5456
+ "#/definitions/Group/groupId"
5457
+ ]
5458
+ },
5459
+ "x-reverse-relationship": {
5460
+ "propertyName": "ordResourceMembers",
5461
+ "description": "The ORD resources that are part the given Group.",
5462
+ "min": 0,
5463
+ "max": "*"
5464
+ },
5465
+ "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.",
5466
+ "examples": []
5467
+ },
5468
+ "version": {
5469
+ "type": "string",
5470
+ "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://swagger.io/specification/#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.",
5471
+ "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-]+)*))?$",
5472
+ "examples": [
5473
+ "1.2.3",
5474
+ "1.0.0-alpha.1"
5475
+ ]
5476
+ },
5477
+ "lastUpdate": {
5478
+ "type": "string",
5479
+ "format": "date-time",
5480
+ "x-introduced-in-version": "1.4.0",
5481
+ "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 `systemInstanceAware`, this property SHOULD be used to optimize the metadata crawling process of the ORD aggregators.",
5482
+ "examples": [
5483
+ "2022-12-19T15:47:04+00:00"
5484
+ ]
5485
+ },
5486
+ "visibility": {
5487
+ "type": "string",
5488
+ "description": "The visibility states who is allowed to \"see\" the described resource or capability.",
5489
+ "oneOf": [
5490
+ {
5491
+ "const": "public",
5492
+ "description": "Resources are 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)."
5493
+ },
5494
+ {
5495
+ "const": "internal",
5496
+ "description": "Resources are 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."
5497
+ },
5498
+ {
5499
+ "const": "private",
5500
+ "description": "Resources that are exclusive within an application or service.\nThis includes resources that may be called from outside but serve purely private purposes and are not supposed to be known by other outside parties.\nE.g., webhooks for provisioning callbacks or backing services.\n\nPrivate resources MUST NOT be made available to public consumers or consumers outside of the \"private\" scope or without the necessary access permissions."
5501
+ }
5502
+ ]
5503
+ },
5504
+ "releaseStatus": {
5505
+ "type": "string",
5506
+ "description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
5507
+ "oneOf": [
5508
+ {
5509
+ "const": "active",
5510
+ "description": "Resource is meant for productive use and provides a stable API contract."
5511
+ },
5512
+ {
5513
+ "const": "beta",
5514
+ "description": "The contract for the resource is beta and MAY not be meant for productive use.\nIn the SAP context, `beta` APIs may be changed or deleted at SAPs discretion."
5515
+ },
5516
+ {
5517
+ "const": "deprecated",
5518
+ "description": "Resource has been deprecated.\n\nIf successor resources exist, they MUST be referenced through `successors`.\nIf it is deprecated without defining its `successors`, a `sunsetDate` SHOULD be provided.\n\nA deprecated resource MAY be decommissioned (removed) in the future, through setting a `Tombstone`.\nOnce the resource is decommissioned, it MUST be removed from ORD (which is why there is no release status for decommissioned)."
5519
+ }
5520
+ ],
5521
+ "examples": [
5522
+ "active"
5523
+ ]
5524
+ },
5525
+ "links": {
5526
+ "type": "array",
5527
+ "description": "Generic links with arbitrary meaning and content.\n\n`packageLinks` MUST be preferred if applicable.",
5528
+ "items": {
5529
+ "$ref": "#/definitions/Link"
5530
+ }
5531
+ },
5532
+ "tags": {
5533
+ "type": "array",
5534
+ "items": {
5535
+ "type": "string",
5536
+ "pattern": "^[a-zA-Z0-9-_.\\/ ]*$",
5537
+ "minLength": 1
5538
+ },
5539
+ "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.",
5540
+ "examples": [
5541
+ [
5542
+ "storage",
5543
+ "high-availability"
5544
+ ]
5545
+ ]
5546
+ },
5547
+ "labels": {
5548
+ "$ref": "#/definitions/Labels",
5549
+ "description": "Generic labels that can be applied to most ORD information."
5550
+ },
5551
+ "documentationLabels": {
5552
+ "$ref": "#/definitions/DocumentationLabels",
5553
+ "description": "Generic documentation labels that can be applied to most ORD information."
5554
+ }
5555
+ },
5556
+ "required": [
5557
+ "ordId",
5558
+ "title",
5559
+ "description",
5560
+ "version",
5561
+ "visibility",
5562
+ "releaseStatus",
5563
+ "partOfPackage"
5564
+ ],
5565
+ "additionalProperties": true
5242
5566
  }
5243
5567
  },
5244
- "title": "ORD Document",
5245
5568
  "type": "object",
5569
+ "x-ums-type": "ignore",
5246
5570
  "properties": {
5247
5571
  "$schema": {
5248
5572
  "type": "string",
@@ -5433,6 +5757,7 @@
5433
5757
  "groups": {
5434
5758
  "type": "array",
5435
5759
  "description": "Array of all Groups that are described in this ORD document.",
5760
+ "x-introduced-in-version": "1.9.0",
5436
5761
  "items": {
5437
5762
  "$ref": "#/definitions/Group"
5438
5763
  }
@@ -5440,6 +5765,7 @@
5440
5765
  "groupTypes": {
5441
5766
  "type": "array",
5442
5767
  "description": "Array of all Group Types that are described in this ORD document.",
5768
+ "x-introduced-in-version": "1.9.0",
5443
5769
  "items": {
5444
5770
  "$ref": "#/definitions/GroupType"
5445
5771
  }