@open-resource-discovery/specification 1.11.1 → 1.12.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.
- package/README.md +6 -0
- package/dist/types/v1/Configuration.d.ts +13 -1
- package/dist/types/v1/Document.d.ts +69 -42
- package/package.json +3 -3
- package/static/spec-v1/interfaces/Configuration.annotated.schema.json +39 -1
- package/static/spec-v1/interfaces/Configuration.schema.json +31 -0
- package/static/spec-v1/interfaces/Document.annotated.schema.json +165 -63
- package/static/spec-v1/interfaces/Document.schema.json +139 -62
|
@@ -530,7 +530,7 @@
|
|
|
530
530
|
"type": "string",
|
|
531
531
|
"format": "date-time",
|
|
532
532
|
"x-introduced-in-version": "1.4.0",
|
|
533
|
-
"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 `
|
|
533
|
+
"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.",
|
|
534
534
|
"examples": [
|
|
535
535
|
"2022-12-19T15:47:04+00:00"
|
|
536
536
|
]
|
|
@@ -788,7 +788,7 @@
|
|
|
788
788
|
"type": "string",
|
|
789
789
|
"format": "date-time",
|
|
790
790
|
"x-introduced-in-version": "1.4.0",
|
|
791
|
-
"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 `
|
|
791
|
+
"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.",
|
|
792
792
|
"examples": [
|
|
793
793
|
"2022-12-19T15:47:04+00:00"
|
|
794
794
|
]
|
|
@@ -815,17 +815,21 @@
|
|
|
815
815
|
"type": "string",
|
|
816
816
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
817
817
|
"oneOf": [
|
|
818
|
+
{
|
|
819
|
+
"const": "beta",
|
|
820
|
+
"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."
|
|
821
|
+
},
|
|
818
822
|
{
|
|
819
823
|
"const": "active",
|
|
820
824
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
821
825
|
},
|
|
822
826
|
{
|
|
823
|
-
"const": "
|
|
824
|
-
"description": "
|
|
827
|
+
"const": "deprecated",
|
|
828
|
+
"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`."
|
|
825
829
|
},
|
|
826
830
|
{
|
|
827
|
-
"const": "
|
|
828
|
-
"description": "Resource has been
|
|
831
|
+
"const": "sunset",
|
|
832
|
+
"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."
|
|
829
833
|
}
|
|
830
834
|
],
|
|
831
835
|
"examples": [
|
|
@@ -844,7 +848,7 @@
|
|
|
844
848
|
"deprecationDate": {
|
|
845
849
|
"type": "string",
|
|
846
850
|
"format": "date-time",
|
|
847
|
-
"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 decommissioned / removed
|
|
851
|
+
"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).",
|
|
848
852
|
"examples": [
|
|
849
853
|
"2020-12-08T15:47:04+00:00"
|
|
850
854
|
]
|
|
@@ -852,7 +856,7 @@
|
|
|
852
856
|
"sunsetDate": {
|
|
853
857
|
"type": "string",
|
|
854
858
|
"format": "date-time",
|
|
855
|
-
"description": "The sunset date defines when the resource is scheduled to be decommissioned/removed.\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).",
|
|
859
|
+
"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).",
|
|
856
860
|
"examples": [
|
|
857
861
|
"2022-01-08T15:47:04+00:00"
|
|
858
862
|
]
|
|
@@ -1478,8 +1482,10 @@
|
|
|
1478
1482
|
},
|
|
1479
1483
|
"systemInstanceAware": {
|
|
1480
1484
|
"type": "boolean",
|
|
1481
|
-
"description": "
|
|
1485
|
+
"description": "All resources that are [system instance aware](../index.md#def-system-instance-aware) should now be put together in one ORD document that has `perspective`: `system-instance`.\nAll resources that are [system instance unaware](../index.md#def-system-instance-unaware) should now be put together in one ORD document that has `perspective`: `system-version`.\n\nDefines whether this ORD resource is **system instance aware**.\nThis is the case (and relevant) 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 that represents a system instance aware perspective MUST fetch the referenced resource definitions,\nnot just once per system type, but once per **system instance**.",
|
|
1482
1486
|
"default": false,
|
|
1487
|
+
"x-deprecated-in-version": "1.12.0",
|
|
1488
|
+
"x-deprecated": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
1483
1489
|
"examples": [
|
|
1484
1490
|
true
|
|
1485
1491
|
]
|
|
@@ -1655,7 +1661,7 @@
|
|
|
1655
1661
|
"type": "string",
|
|
1656
1662
|
"format": "date-time",
|
|
1657
1663
|
"x-introduced-in-version": "1.4.0",
|
|
1658
|
-
"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 `
|
|
1664
|
+
"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.",
|
|
1659
1665
|
"examples": [
|
|
1660
1666
|
"2022-12-19T15:47:04+00:00"
|
|
1661
1667
|
]
|
|
@@ -1682,17 +1688,21 @@
|
|
|
1682
1688
|
"type": "string",
|
|
1683
1689
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
1684
1690
|
"oneOf": [
|
|
1691
|
+
{
|
|
1692
|
+
"const": "beta",
|
|
1693
|
+
"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."
|
|
1694
|
+
},
|
|
1685
1695
|
{
|
|
1686
1696
|
"const": "active",
|
|
1687
1697
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
1688
1698
|
},
|
|
1689
1699
|
{
|
|
1690
|
-
"const": "
|
|
1691
|
-
"description": "
|
|
1700
|
+
"const": "deprecated",
|
|
1701
|
+
"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`."
|
|
1692
1702
|
},
|
|
1693
1703
|
{
|
|
1694
|
-
"const": "
|
|
1695
|
-
"description": "Resource has been
|
|
1704
|
+
"const": "sunset",
|
|
1705
|
+
"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."
|
|
1696
1706
|
}
|
|
1697
1707
|
],
|
|
1698
1708
|
"examples": [
|
|
@@ -1711,7 +1721,7 @@
|
|
|
1711
1721
|
"deprecationDate": {
|
|
1712
1722
|
"type": "string",
|
|
1713
1723
|
"format": "date-time",
|
|
1714
|
-
"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 decommissioned / removed
|
|
1724
|
+
"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).",
|
|
1715
1725
|
"examples": [
|
|
1716
1726
|
"2020-12-08T15:47:04+00:00"
|
|
1717
1727
|
]
|
|
@@ -1719,7 +1729,7 @@
|
|
|
1719
1729
|
"sunsetDate": {
|
|
1720
1730
|
"type": "string",
|
|
1721
1731
|
"format": "date-time",
|
|
1722
|
-
"description": "The sunset date defines when the resource is scheduled to be decommissioned/removed.\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).",
|
|
1732
|
+
"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).",
|
|
1723
1733
|
"examples": [
|
|
1724
1734
|
"2022-01-08T15:47:04+00:00"
|
|
1725
1735
|
]
|
|
@@ -2164,8 +2174,10 @@
|
|
|
2164
2174
|
},
|
|
2165
2175
|
"systemInstanceAware": {
|
|
2166
2176
|
"type": "boolean",
|
|
2167
|
-
"description": "
|
|
2177
|
+
"description": "All resources that are [system instance aware](../index.md#def-system-instance-aware) should now be put together in one ORD document that has `perspective`: `system-instance`.\nAll resources that are [system instance unaware](../index.md#def-system-instance-unaware) should now be put together in one ORD document that has `perspective`: `system-version`.\n\nDefines whether this ORD resource is **system instance aware**.\nThis is the case (and relevant) 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 that represents a system instance aware perspective MUST fetch the referenced resource definitions,\nnot just once per system type, but once per **system instance**.",
|
|
2168
2178
|
"default": false,
|
|
2179
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2180
|
+
"x-deprecated": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2169
2181
|
"examples": [
|
|
2170
2182
|
true
|
|
2171
2183
|
]
|
|
@@ -2331,7 +2343,7 @@
|
|
|
2331
2343
|
"type": "string",
|
|
2332
2344
|
"format": "date-time",
|
|
2333
2345
|
"x-introduced-in-version": "1.4.0",
|
|
2334
|
-
"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 `
|
|
2346
|
+
"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.",
|
|
2335
2347
|
"examples": [
|
|
2336
2348
|
"2022-12-19T15:47:04+00:00"
|
|
2337
2349
|
]
|
|
@@ -2358,17 +2370,21 @@
|
|
|
2358
2370
|
"type": "string",
|
|
2359
2371
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
2360
2372
|
"oneOf": [
|
|
2373
|
+
{
|
|
2374
|
+
"const": "beta",
|
|
2375
|
+
"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."
|
|
2376
|
+
},
|
|
2361
2377
|
{
|
|
2362
2378
|
"const": "active",
|
|
2363
2379
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
2364
2380
|
},
|
|
2365
2381
|
{
|
|
2366
|
-
"const": "
|
|
2367
|
-
"description": "
|
|
2382
|
+
"const": "deprecated",
|
|
2383
|
+
"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`."
|
|
2368
2384
|
},
|
|
2369
2385
|
{
|
|
2370
|
-
"const": "
|
|
2371
|
-
"description": "Resource has been
|
|
2386
|
+
"const": "sunset",
|
|
2387
|
+
"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."
|
|
2372
2388
|
}
|
|
2373
2389
|
],
|
|
2374
2390
|
"examples": [
|
|
@@ -2378,7 +2394,7 @@
|
|
|
2378
2394
|
"deprecationDate": {
|
|
2379
2395
|
"type": "string",
|
|
2380
2396
|
"format": "date-time",
|
|
2381
|
-
"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 decommissioned / removed
|
|
2397
|
+
"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).",
|
|
2382
2398
|
"examples": [
|
|
2383
2399
|
"2020-12-08T15:47:04+00:00"
|
|
2384
2400
|
]
|
|
@@ -2386,7 +2402,7 @@
|
|
|
2386
2402
|
"sunsetDate": {
|
|
2387
2403
|
"type": "string",
|
|
2388
2404
|
"format": "date-time",
|
|
2389
|
-
"description": "The sunset date defines when the resource is scheduled to be decommissioned/removed.\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).",
|
|
2405
|
+
"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).",
|
|
2390
2406
|
"examples": [
|
|
2391
2407
|
"2022-01-08T15:47:04+00:00"
|
|
2392
2408
|
]
|
|
@@ -2556,8 +2572,10 @@
|
|
|
2556
2572
|
},
|
|
2557
2573
|
"systemInstanceAware": {
|
|
2558
2574
|
"type": "boolean",
|
|
2559
|
-
"description": "
|
|
2575
|
+
"description": "All resources that are [system instance aware](../index.md#def-system-instance-aware) should now be put together in one ORD document that has `perspective`: `system-instance`.\nAll resources that are [system instance unaware](../index.md#def-system-instance-unaware) should now be put together in one ORD document that has `perspective`: `system-version`.\n\nDefines whether this ORD resource is **system instance aware**.\nThis is the case (and relevant) 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 that represents a system instance aware perspective MUST fetch the referenced resource definitions,\nnot just once per system type, but once per **system instance**.",
|
|
2560
2576
|
"default": false,
|
|
2577
|
+
"x-deprecated-in-version": "1.12.0",
|
|
2578
|
+
"x-deprecated": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
2561
2579
|
"examples": [
|
|
2562
2580
|
true
|
|
2563
2581
|
]
|
|
@@ -2710,7 +2728,7 @@
|
|
|
2710
2728
|
"type": "string",
|
|
2711
2729
|
"format": "date-time",
|
|
2712
2730
|
"x-introduced-in-version": "1.4.0",
|
|
2713
|
-
"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 `
|
|
2731
|
+
"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.",
|
|
2714
2732
|
"examples": [
|
|
2715
2733
|
"2022-12-19T15:47:04+00:00"
|
|
2716
2734
|
]
|
|
@@ -2737,17 +2755,21 @@
|
|
|
2737
2755
|
"type": "string",
|
|
2738
2756
|
"description": "The `releaseStatus` specifies the stability towards incompatible changes in the future.\nIn the context of data products, it it covers only properties on the data product level.\nAPIs that are part of the input and output ports have their own independent `releaseStatus` and `version`.",
|
|
2739
2757
|
"oneOf": [
|
|
2758
|
+
{
|
|
2759
|
+
"const": "beta",
|
|
2760
|
+
"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."
|
|
2761
|
+
},
|
|
2740
2762
|
{
|
|
2741
2763
|
"const": "active",
|
|
2742
2764
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
2743
2765
|
},
|
|
2744
2766
|
{
|
|
2745
|
-
"const": "
|
|
2746
|
-
"description": "
|
|
2767
|
+
"const": "deprecated",
|
|
2768
|
+
"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`."
|
|
2747
2769
|
},
|
|
2748
2770
|
{
|
|
2749
|
-
"const": "
|
|
2750
|
-
"description": "Resource has been
|
|
2771
|
+
"const": "sunset",
|
|
2772
|
+
"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."
|
|
2751
2773
|
}
|
|
2752
2774
|
],
|
|
2753
2775
|
"examples": [
|
|
@@ -2806,7 +2828,7 @@
|
|
|
2806
2828
|
"x-feature-status": "beta",
|
|
2807
2829
|
"type": "string",
|
|
2808
2830
|
"format": "date-time",
|
|
2809
|
-
"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 decommissioned / removed
|
|
2831
|
+
"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).",
|
|
2810
2832
|
"examples": [
|
|
2811
2833
|
"2020-12-08T15:47:04+00:00"
|
|
2812
2834
|
]
|
|
@@ -2815,7 +2837,7 @@
|
|
|
2815
2837
|
"x-feature-status": "beta",
|
|
2816
2838
|
"type": "string",
|
|
2817
2839
|
"format": "date-time",
|
|
2818
|
-
"description": "The sunset date defines when the resource is scheduled to be decommissioned/removed.\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).",
|
|
2840
|
+
"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).",
|
|
2819
2841
|
"examples": [
|
|
2820
2842
|
"2022-01-08T15:47:04+00:00"
|
|
2821
2843
|
]
|
|
@@ -3278,8 +3300,10 @@
|
|
|
3278
3300
|
"systemInstanceAware": {
|
|
3279
3301
|
"x-feature-status": "beta",
|
|
3280
3302
|
"type": "boolean",
|
|
3281
|
-
"description": "
|
|
3303
|
+
"description": "All resources that are [system instance aware](../index.md#def-system-instance-aware) should now be put together in one ORD document that has `perspective`: `system-instance`.\nAll resources that are [system instance unaware](../index.md#def-system-instance-unaware) should now be put together in one ORD document that has `perspective`: `system-version`.\n\nDefines whether this ORD resource is **system instance aware**.\nThis is the case (and relevant) 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 that represents a system instance aware perspective MUST fetch the referenced resource definitions,\nnot just once per system type, but once per **system instance**.",
|
|
3282
3304
|
"default": false,
|
|
3305
|
+
"x-deprecated-in-version": "1.12.0",
|
|
3306
|
+
"x-deprecated": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
3283
3307
|
"examples": [
|
|
3284
3308
|
true
|
|
3285
3309
|
]
|
|
@@ -3847,7 +3871,7 @@
|
|
|
3847
3871
|
"type": "string",
|
|
3848
3872
|
"format": "date-time",
|
|
3849
3873
|
"x-introduced-in-version": "1.4.0",
|
|
3850
|
-
"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 `
|
|
3874
|
+
"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.",
|
|
3851
3875
|
"examples": [
|
|
3852
3876
|
"2022-12-19T15:47:04+00:00"
|
|
3853
3877
|
]
|
|
@@ -3874,17 +3898,21 @@
|
|
|
3874
3898
|
"type": "string",
|
|
3875
3899
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
3876
3900
|
"oneOf": [
|
|
3901
|
+
{
|
|
3902
|
+
"const": "beta",
|
|
3903
|
+
"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."
|
|
3904
|
+
},
|
|
3877
3905
|
{
|
|
3878
3906
|
"const": "active",
|
|
3879
3907
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
3880
3908
|
},
|
|
3881
3909
|
{
|
|
3882
|
-
"const": "
|
|
3883
|
-
"description": "
|
|
3910
|
+
"const": "deprecated",
|
|
3911
|
+
"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`."
|
|
3884
3912
|
},
|
|
3885
3913
|
{
|
|
3886
|
-
"const": "
|
|
3887
|
-
"description": "Resource has been
|
|
3914
|
+
"const": "sunset",
|
|
3915
|
+
"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."
|
|
3888
3916
|
}
|
|
3889
3917
|
],
|
|
3890
3918
|
"examples": [
|
|
@@ -3961,8 +3989,10 @@
|
|
|
3961
3989
|
},
|
|
3962
3990
|
"systemInstanceAware": {
|
|
3963
3991
|
"type": "boolean",
|
|
3964
|
-
"description": "
|
|
3992
|
+
"description": "All resources that are [system instance aware](../index.md#def-system-instance-aware) should now be put together in one ORD document that has `perspective`: `system-instance`.\nAll resources that are [system instance unaware](../index.md#def-system-instance-unaware) should now be put together in one ORD document that has `perspective`: `system-version`.\n\nDefines whether this ORD resource is **system instance aware**.\nThis is the case (and relevant) 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 that represents a system instance aware perspective MUST fetch the referenced resource definitions,\nnot just once per system type, but once per **system instance**.",
|
|
3965
3993
|
"default": false,
|
|
3994
|
+
"x-deprecated-in-version": "1.12.0",
|
|
3995
|
+
"x-deprecated": "Use `perspectives` instead (see [perspectives](../concepts/perspectives) article).",
|
|
3966
3996
|
"examples": [
|
|
3967
3997
|
true
|
|
3968
3998
|
]
|
|
@@ -4189,7 +4219,7 @@
|
|
|
4189
4219
|
"type": "string",
|
|
4190
4220
|
"format": "date-time",
|
|
4191
4221
|
"x-introduced-in-version": "1.4.0",
|
|
4192
|
-
"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 `
|
|
4222
|
+
"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.",
|
|
4193
4223
|
"examples": [
|
|
4194
4224
|
"2022-12-19T15:47:04+00:00"
|
|
4195
4225
|
]
|
|
@@ -4216,17 +4246,21 @@
|
|
|
4216
4246
|
"type": "string",
|
|
4217
4247
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
4218
4248
|
"oneOf": [
|
|
4249
|
+
{
|
|
4250
|
+
"const": "beta",
|
|
4251
|
+
"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."
|
|
4252
|
+
},
|
|
4219
4253
|
{
|
|
4220
4254
|
"const": "active",
|
|
4221
4255
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
4222
4256
|
},
|
|
4223
4257
|
{
|
|
4224
|
-
"const": "
|
|
4225
|
-
"description": "
|
|
4258
|
+
"const": "deprecated",
|
|
4259
|
+
"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`."
|
|
4226
4260
|
},
|
|
4227
4261
|
{
|
|
4228
|
-
"const": "
|
|
4229
|
-
"description": "Resource has been
|
|
4262
|
+
"const": "sunset",
|
|
4263
|
+
"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."
|
|
4230
4264
|
}
|
|
4231
4265
|
],
|
|
4232
4266
|
"examples": [
|
|
@@ -4236,7 +4270,7 @@
|
|
|
4236
4270
|
"sunsetDate": {
|
|
4237
4271
|
"type": "string",
|
|
4238
4272
|
"format": "date-time",
|
|
4239
|
-
"description": "The sunset date defines when the resource is scheduled to be decommissioned/removed.\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).",
|
|
4273
|
+
"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).",
|
|
4240
4274
|
"examples": [
|
|
4241
4275
|
"2022-01-08T15:47:04+00:00"
|
|
4242
4276
|
]
|
|
@@ -4574,17 +4608,21 @@
|
|
|
4574
4608
|
"type": "string",
|
|
4575
4609
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
4576
4610
|
"oneOf": [
|
|
4611
|
+
{
|
|
4612
|
+
"const": "beta",
|
|
4613
|
+
"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."
|
|
4614
|
+
},
|
|
4577
4615
|
{
|
|
4578
4616
|
"const": "active",
|
|
4579
4617
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
4580
4618
|
},
|
|
4581
4619
|
{
|
|
4582
|
-
"const": "
|
|
4583
|
-
"description": "
|
|
4620
|
+
"const": "deprecated",
|
|
4621
|
+
"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`."
|
|
4584
4622
|
},
|
|
4585
4623
|
{
|
|
4586
|
-
"const": "
|
|
4587
|
-
"description": "Resource has been
|
|
4624
|
+
"const": "sunset",
|
|
4625
|
+
"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."
|
|
4588
4626
|
}
|
|
4589
4627
|
],
|
|
4590
4628
|
"examples": [
|
|
@@ -4969,8 +5007,9 @@
|
|
|
4969
5007
|
"properties": {
|
|
4970
5008
|
"systemNamespace": {
|
|
4971
5009
|
"type": "string",
|
|
4972
|
-
"description": "The system namespace is a unique identifier for the system type.\nIt is used to reference the system type in the ORD.",
|
|
5010
|
+
"description": "The [system namespace](../index.md#system-namespace) is a unique identifier for the system type.\nIt is used to reference the system type in the ORD.",
|
|
4973
5011
|
"pattern": "^[a-z0-9]+(?:[.][a-z0-9]+){1}$",
|
|
5012
|
+
"maxLength": 32,
|
|
4974
5013
|
"examples": [
|
|
4975
5014
|
"sap.s4",
|
|
4976
5015
|
"sap.c4c",
|
|
@@ -5025,7 +5064,7 @@
|
|
|
5025
5064
|
"properties": {
|
|
5026
5065
|
"version": {
|
|
5027
5066
|
"type": "string",
|
|
5028
|
-
"description": "The version
|
|
5067
|
+
"description": "The version of the system instance (run-time) or the version of the described system-version perspective.\n\nIt MUST follow the [Semantic Versioning 2.0.0](https://semver.org/) standard.\n\nMUST be provided if the ORD document is `perspective`: `system-version`.\n\nFor continuous-delivery systems, the version MAY be fixed to the same value, e.g. `1.0.0`, but be aware that phased rollouts may benefit from a more precise versioning like adding a build number.",
|
|
5029
5068
|
"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-]+)*))?$",
|
|
5030
5069
|
"examples": [
|
|
5031
5070
|
"1.2.3",
|
|
@@ -5096,6 +5135,11 @@
|
|
|
5096
5135
|
"const": "open",
|
|
5097
5136
|
"description": "The resource definitions are openly accessible and not protected via authentication or authorization.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/open)."
|
|
5098
5137
|
},
|
|
5138
|
+
{
|
|
5139
|
+
"const": "basic-auth",
|
|
5140
|
+
"description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).",
|
|
5141
|
+
"x-introduced-in-version": "1.12.1"
|
|
5142
|
+
},
|
|
5099
5143
|
{
|
|
5100
5144
|
"const": "sap:oauth-client-credentials:v1",
|
|
5101
5145
|
"description": "The ORD information are accessible via OAuth 2.0 client credentials flow as standardized within SAP.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-oauth-client-credentials-v1)."
|
|
@@ -5106,7 +5150,9 @@
|
|
|
5106
5150
|
},
|
|
5107
5151
|
{
|
|
5108
5152
|
"const": "sap.businesshub:basic-auth:v1",
|
|
5109
|
-
"description": "The ORD information are accessible for SAP Business Accelerator Hub via Basic Auth strategy.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-businesshub-basic-v1)."
|
|
5153
|
+
"description": "The ORD information are accessible for SAP Business Accelerator Hub via Basic Auth strategy.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-businesshub-basic-v1).",
|
|
5154
|
+
"x-deprecated-in-version": "1.12.1",
|
|
5155
|
+
"x-deprecated": "This access strategy is deprecated and will be removed in a future version of the specification.\nPlease use `basic-auth` instead."
|
|
5110
5156
|
},
|
|
5111
5157
|
{
|
|
5112
5158
|
"const": "custom",
|
|
@@ -5567,7 +5613,7 @@
|
|
|
5567
5613
|
"x-introduced-in-version": "1.9.0",
|
|
5568
5614
|
"x-ums-type": "embedded",
|
|
5569
5615
|
"type": "object",
|
|
5570
|
-
"description": "Defines
|
|
5616
|
+
"description": "Defines the relation between Entity Types (via its ORD ID).",
|
|
5571
5617
|
"properties": {
|
|
5572
5618
|
"ordId": {
|
|
5573
5619
|
"type": "string",
|
|
@@ -5579,6 +5625,31 @@
|
|
|
5579
5625
|
],
|
|
5580
5626
|
"x-association-target": [
|
|
5581
5627
|
"#/definitions/EntityType/ordId"
|
|
5628
|
+
],
|
|
5629
|
+
"x-reverse-relationship": {
|
|
5630
|
+
"propertyName": "inverseRelatedEntityTypes",
|
|
5631
|
+
"description": "Entity types that defined a relationship to this entity type",
|
|
5632
|
+
"min": 0,
|
|
5633
|
+
"max": "*"
|
|
5634
|
+
}
|
|
5635
|
+
},
|
|
5636
|
+
"relationType": {
|
|
5637
|
+
"type": "string",
|
|
5638
|
+
"description": "Optional type of the relationship, which defines a stricter semantic what the relationship implies.\n\nIf not provided, the relationship type has no semantics, it's \"related somehow\".",
|
|
5639
|
+
"x-introduced-in-version": "1.12.0",
|
|
5640
|
+
"x-feature-status": "beta",
|
|
5641
|
+
"oneOf": [
|
|
5642
|
+
{
|
|
5643
|
+
"const": "part-of",
|
|
5644
|
+
"description": "The described entity type is a composite part of the referenced entity type.\nE.g. a `SalesOrderItem` is part of a `SalesOrder`."
|
|
5645
|
+
},
|
|
5646
|
+
{
|
|
5647
|
+
"const": "can-share-identity",
|
|
5648
|
+
"description": "The related entity types can potentially share the same identity in their instance data / be ID mapped.\n\nE.g. a `BusinessPartner` can share the same identity as a `NaturalPerson`."
|
|
5649
|
+
}
|
|
5650
|
+
],
|
|
5651
|
+
"examples": [
|
|
5652
|
+
"can-share-identity"
|
|
5582
5653
|
]
|
|
5583
5654
|
}
|
|
5584
5655
|
},
|
|
@@ -5616,7 +5687,7 @@
|
|
|
5616
5687
|
"type": "object",
|
|
5617
5688
|
"title": "Tombstone",
|
|
5618
5689
|
"x-ums-type": "ignore",
|
|
5619
|
-
"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\
|
|
5690
|
+
"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.",
|
|
5620
5691
|
"properties": {
|
|
5621
5692
|
"ordId": {
|
|
5622
5693
|
"type": "string",
|
|
@@ -5786,7 +5857,7 @@
|
|
|
5786
5857
|
"type": "string",
|
|
5787
5858
|
"format": "date-time",
|
|
5788
5859
|
"x-introduced-in-version": "1.4.0",
|
|
5789
|
-
"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 `
|
|
5860
|
+
"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.",
|
|
5790
5861
|
"examples": [
|
|
5791
5862
|
"2022-12-19T15:47:04+00:00"
|
|
5792
5863
|
]
|
|
@@ -5813,17 +5884,21 @@
|
|
|
5813
5884
|
"type": "string",
|
|
5814
5885
|
"description": "The `releaseStatus` specifies the stability of the resource and its external contract.",
|
|
5815
5886
|
"oneOf": [
|
|
5887
|
+
{
|
|
5888
|
+
"const": "beta",
|
|
5889
|
+
"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."
|
|
5890
|
+
},
|
|
5816
5891
|
{
|
|
5817
5892
|
"const": "active",
|
|
5818
5893
|
"description": "Resource is meant for productive use and provides a stable API contract."
|
|
5819
5894
|
},
|
|
5820
5895
|
{
|
|
5821
|
-
"const": "
|
|
5822
|
-
"description": "
|
|
5896
|
+
"const": "deprecated",
|
|
5897
|
+
"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`."
|
|
5823
5898
|
},
|
|
5824
5899
|
{
|
|
5825
|
-
"const": "
|
|
5826
|
-
"description": "Resource has been
|
|
5900
|
+
"const": "sunset",
|
|
5901
|
+
"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."
|
|
5827
5902
|
}
|
|
5828
5903
|
],
|
|
5829
5904
|
"examples": [
|
|
@@ -5905,10 +5980,11 @@
|
|
|
5905
5980
|
"1.8",
|
|
5906
5981
|
"1.9",
|
|
5907
5982
|
"1.10",
|
|
5908
|
-
"1.11"
|
|
5983
|
+
"1.11",
|
|
5984
|
+
"1.12"
|
|
5909
5985
|
],
|
|
5910
5986
|
"examples": [
|
|
5911
|
-
"1.
|
|
5987
|
+
"1.12"
|
|
5912
5988
|
]
|
|
5913
5989
|
},
|
|
5914
5990
|
"description": {
|
|
@@ -5919,16 +5995,42 @@
|
|
|
5919
5995
|
"This ORD document contains all APIs that are system instance aware and have APIs that\ncan change their behavior at runtime.\n"
|
|
5920
5996
|
]
|
|
5921
5997
|
},
|
|
5998
|
+
"perspective": {
|
|
5999
|
+
"type": "string",
|
|
6000
|
+
"x-introduced-in-version": "1.12.0",
|
|
6001
|
+
"x-feature-status": "beta",
|
|
6002
|
+
"description": "With ORD it's possible to describe a system from a static or a dynamic [perspective](../index.md#perspectives) (for more details, follow the link).\n\nIt is strongly RECOMMENDED to mark all static ORD documents with perspective `system-version`.\n\nIt is RECOMMENDED to describe dynamic metadata in both static system-version perspective and additionally describe the system-instance perspective where it diverges from the static metadata.\n\nIf not provided, this defaults to `system-instance`, which is the most precise description but also the most costly to replicate.\n\nPlease read the [article on perspectives](../concepts/perspectives) for more explanations.",
|
|
6003
|
+
"oneOf": [
|
|
6004
|
+
{
|
|
6005
|
+
"const": "system-version",
|
|
6006
|
+
"description": "Describes the static [system-version](../index.md#def-system-version) perspective, usually known at deploy-time.\n\nIf chosen, `describedSystemVersion`.`version` MUST be provided, too.\n\nThis perspective describes how a system of a particular type and version generally look like.\nThe latest system-version MAY also be interpreted as the [system-type](../index.md#def-system-type) perspective."
|
|
6007
|
+
},
|
|
6008
|
+
{
|
|
6009
|
+
"const": "system-instance",
|
|
6010
|
+
"description": "Describes the complete dynamic [system-instance](../index.md#def-system-instance) (tenant) perspective as known at run-time.\nThis allows to also reflect tenant specific extensions, customizations and runtime configuration.\n\nIf provided, it will completely override the static system-version perspective when metadata about system instances is requested."
|
|
6011
|
+
},
|
|
6012
|
+
{
|
|
6013
|
+
"const": "system-independent",
|
|
6014
|
+
"description": "Describes content that is independent of [system-versions](../index.md#def-system-version) or [system-instances](../index.md#def-system-instance).\nThis content is always static and has independent visibility and lifecycle from the systems in a particular landscape.\nThe \"system-independent\" content MUST NOT be overridden via system-version or system-instance perspective metadata.\n\nExamples are: Vendors, products, globally aligned entity types, groups and group types (taxonomy), which are usually shared by multiple systems."
|
|
6015
|
+
}
|
|
6016
|
+
],
|
|
6017
|
+
"default": "system instance",
|
|
6018
|
+
"examples": [
|
|
6019
|
+
"system-instance"
|
|
6020
|
+
]
|
|
6021
|
+
},
|
|
5922
6022
|
"describedSystemInstance": {
|
|
5923
6023
|
"$ref": "#/definitions/SystemInstance",
|
|
5924
|
-
"description": "Information on the [system
|
|
6024
|
+
"description": "Information on the [system-instance](../index.md#def-system-instance) that this ORD document describes.\n\nWhether this information is required or recommended to add, depends on the requirements of the ORD aggregator."
|
|
5925
6025
|
},
|
|
5926
6026
|
"describedSystemType": {
|
|
5927
6027
|
"$ref": "#/definitions/SystemType",
|
|
6028
|
+
"x-introduced-in-version": "1.10.0",
|
|
5928
6029
|
"description": "Information on the [system type](../index.md#def-system-type) that this ORD document describes."
|
|
5929
6030
|
},
|
|
5930
6031
|
"describedSystemVersion": {
|
|
5931
6032
|
"$ref": "#/definitions/SystemVersion",
|
|
6033
|
+
"x-introduced-in-version": "1.10.0",
|
|
5932
6034
|
"description": "Information on the [system version](../index.md#def-system-version) that this ORD document describes."
|
|
5933
6035
|
},
|
|
5934
6036
|
"policyLevel": {
|
|
@@ -6086,7 +6188,7 @@
|
|
|
6086
6188
|
},
|
|
6087
6189
|
"tombstones": {
|
|
6088
6190
|
"type": "array",
|
|
6089
|
-
"description": "List of ORD information (resources or taxonomy) that have been \"tombstoned\"
|
|
6191
|
+
"description": "List of ORD information (resources or taxonomy) that have been \"tombstoned\", indicating removal or archival.\nThis MUST be indicated explicitly, just removing the ORD information itself is not sufficient.\n\nA tombstone entry MAY be removed after a grace period of 31 days.",
|
|
6090
6192
|
"items": {
|
|
6091
6193
|
"$ref": "#/definitions/Tombstone"
|
|
6092
6194
|
}
|