@open-resource-discovery/specification 1.12.3 → 1.14.0

package/README.md

@@ -7,14 +7,13 @@
 
 ## Summary
 
-Open Resource Discovery (ORD) is a protocol that **allows applications and services to self-describe their exposed resources and capabilities**.
-It can be used to describe static documentation, but can also reflect tenant specific configuration and extensions (at run-time).​
+Open Resource Discovery (ORD) is a protocol that **enables applications and services to self-describe their exposed resources and capabilities**. It supports both static documentation and runtime tenant-specific configuration and extensions.
 
-**To learn more, have a look at the [Open Resource Discovery Specification](https://open-resource-discovery.github.io/specification/) documentation.**
+**To learn more, have a look at the [Open Resource Discovery Specification](https://open-resource-discovery.org/) documentation.**
 
 > ℹ ORD is an open standard by SAP, currently geared towards the SAP ecosystem.
-> However, it is built to be a generic standard and could be used outside of SAP, if the infrastructure (aggregators, namespace registry) is built or adjusted.
-> The standard is extensible through extensibility attributes, custom types and policy levels.
+> However, it is designed as a generic standard that can be used outside SAP with appropriate infrastructure (aggregators and namespace registry).
+> The standard is extensible through extensibility attributes, custom types, and policy levels.
 
 ## Communication, Feedback & FAQ
 
@@ -26,11 +25,6 @@ The ORD standard is governed by the [Linux Foundation](https://www.linuxfoundati
 
 ## Resources
 
-### Learning Material
-
-Currently there are no public resources beside the ORD spec itself.
-We plan to add more in the future.
-
 ### Tools and Examples
 
 #### ORD Reference Application

package/dist/generated/spec/v1/schemas/{configuration.schema.json → Configuration.schema.json}

@@ -1,7 +1,7 @@
 {
-    "description": "The ORD configuration response will indicate that ORD is available for the given host and how to proceed with the discovery.\n\nMost notably, the ORD configuration will tell an ORD consumer which ORD documents are available and where/how they can be accessed.\n\nThe configuration endpoint is a [Well-Known URI](https://tools.ietf.org/html/rfc8615#section-3) discovery mechanism.\n\nThis JSON Schema describes the [ORD configuration interface](https://open-resource-discovery.github.io/specification/spec-v1/interfaces/configuration) of the [ORD specification](https://open-resource-discovery.github.io/specification/).",
+    "description": "The ORD configuration response will indicate that ORD is available for the given host and how to proceed with the discovery.\n\nMost notably, the ORD configuration will tell an ORD consumer which ORD documents are available and where/how they can be accessed.\n\nThe configuration endpoint is a [Well-Known URI](https://tools.ietf.org/html/rfc8615#section-3) discovery mechanism.\n\nThis JSON Schema describes the [ORD configuration interface](https://open-resource-discovery.org/spec-v1/interfaces/Configuration) of the [ORD specification](https://open-resource-discovery.org/).",
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#",
+    "$id": "https://open-resource-discovery.org/spec-v1/interfaces/Configuration.schema.json#",
     "title": "Ord Configuration",
     "type": "object",
     "properties": {
@@ -15,14 +15,14 @@
                     "format": "uri-reference"
                 },
                 {
-                    "const": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#"
+                    "const": "https://open-resource-discovery.org/spec-v1/interfaces/Configuration.schema.json#"
                 }
             ]
         },
         "baseUrl": {
             "type": "string",
             "format": "uri",
-            "description": "Optional [base URL](../index.md#def-base-url) that can be used to resolve the relative URLs to the ORD Documents.\n\nThe `baseUrl` MUST not contain a leading slash.\n\nIf you do not provide this property, the base URL is assumed to be the URL of the config endpoint without `/.well-known/open-resource-discovery` suffix.\nThis implies that either a `baseUrl` or only absolute URLs MUST be provided when no standardized well-known URI is used.\nIf both a `baseUrl` and a well-known URI is provided, the explicit `baseUrl` takes precedence.",
+            "description": "Optional [base URL](../index.md#base-url) that can be used to resolve the relative URLs to the ORD Documents.\n\nThe `baseUrl` MUST NOT contain a leading slash.\n\nIf you do not provide this property, the base URL is assumed to be the URL of the config endpoint without `/.well-known/open-resource-discovery` suffix.\nThis implies that either a `baseUrl` or only absolute URLs MUST be provided when no standardized well-known URI is used.\nIf both a `baseUrl` and a well-known URI is provided, the explicit `baseUrl` takes precedence.",
             "pattern": "^http[s]?:\\/\\/[^:\\/\\s]+\\.[^:\\/\\s\\.]+(:\\d+)?(\\/[a-zA-Z0-9-\\._~]+)*$",
             "examples": [
                 "https://example-sap-system.com",
@@ -43,6 +43,7 @@
             "type": "object",
             "title": "Ord V1 Support",
             "description": "The existence of this version indicates that Open Resource Discovery is supported in Version 1.x",
+            "x-ums-type": "ignore",
             "properties": {
                 "documents": {
                     "type": "array",
@@ -61,6 +62,7 @@
             "type": "object",
             "title": "Ord V1 Document Description",
             "description": "Describes an [ORD Document](../index.md#ord-document) that is available for pull transport consumption.",
+            "x-ums-type": "ignore",
             "properties": {
                 "url": {
                     "type": "string",
@@ -78,17 +80,21 @@
                     "x-feature-status": "beta",
                     "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.",
                     "oneOf": [
+                        {
+                            "const": "system-type",
+                            "description": "Describes a static [system-type](../index.md#def-system-type) perspective, which is version independent.\n\nIf a system is not versioned (continuous delivery) or resources are not tied to a system, the system-type perspective\nimplies that the information apply, no matter which system version or instance."
+                        },
                         {
                             "const": "system-version",
-                            "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."
+                            "description": "Describes the static [system-version](../index.md#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#system-type) perspective."
                         },
                         {
                             "const": "system-instance",
-                            "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."
+                            "description": "Describes the complete dynamic [system-instance](../index.md#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."
                         },
                         {
                             "const": "system-independent",
-                            "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."
+                            "description": "Describes content that is independent of [system-versions](../index.md#system-version) or [system-instances](../index.md#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."
                         }
                     ],
                     "default": "system-instance",
@@ -98,7 +104,7 @@
                 },
                 "systemInstanceAware": {
                     "type": "boolean",
-                    "description": "Whether the information in the ORD document is **system instance aware**.\n\nThis is the case when the provided ORD document potentially differs between **system instances**.\nPlease note that if a system does not support multi-tenancy, most likely each system instance has its own\nURL and different system instances could even be deployed in a different state (version).\nIf those conditions apply, `systemInstanceAware` MUST be set to true.\n\nAn ORD aggregator that represents a system instance aware perspective MUST fetch a system instance aware ORD document,\nnot just once per system type but once per **system instance**.\n\nPlease note that you can define system instance awareness also on the level of an ORD resource.\nIt is even possible and valid to have an ORD document that is NOT system instance aware to contain resources that are.\nThis can be the case because the resource is described in separate resource definition formats which would change,\nwhile the ORD document itself would not change (the links to the resource definition files stay the same).\n\nIf some ORD information is **system instance aware** and some is not,\nwe RECOMMEND to split the information into separate documents and mark their system instance awareness accordingly.",
+                    "description": "Whether the information in the ORD document is **system-instance-aware**.\nThis is the case when the provided ORD document potentially differs between **system instances** (e.g. due to multi-tenancy, configuration or extensibility).\n\nIf a document is system-instance-aware, an ORD aggregator MUST fetch it for _each_ **system instance** (tenant), not just once per system type.\n\nThis concept is now **deprecated** in favor of the more explicit `perspective` attribute.\nIt is strongly RECOMMENDED to split metadata into separate documents for the different perspectives (static vs. dynamic).\n\nFor a detailed explanation, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).",
                     "default": false,
                     "examples": [
                         true
@@ -123,11 +129,12 @@
             "type": "object",
             "title": "Ord V1 Capabilities",
             "description": "List of capabilities that are supported by the ORD provider.",
+            "x-ums-type": "ignore",
             "properties": {
                 "selector": {
                     "type": "boolean",
                     "default": false,
-                    "description": "Whether the ORD provider supports the optional [select parameter](../index.md#select-parameter) for retrieving the ORD config and ORD documents."
+                    "description": "Whether the ORD provider supports the optional `select` parameter ([select parameter](../index.md#select-parameter)) for retrieving the ORD config and ORD documents."
                 }
             }
         },
@@ -135,14 +142,15 @@
             "type": "object",
             "title": "Ord V1 Document Access Strategy",
             "description": "Defines the [access strategy](../../spec-extensions/access-strategies/) for accessing the ORD documents from the ORD provider.",
+            "x-ums-type": "ignore",
             "properties": {
                 "type": {
                     "type": "string",
                     "description": "Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.",
-                    "oneOf": [
+                    "anyOf": [
                         {
                             "type": "string",
-                            "pattern": "^([a-z0-9-]+(?:[.][a-z0-9-]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
+                            "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
                             "description": "Any valid [Specification ID](../index.md#specification-id).\nIf chosen, `customDescription` SHOULD be provided."
                         },
                         {
@@ -154,18 +162,6 @@
                             "description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).",
                             "x-introduced-in-version": "1.12.1"
                         },
-                        {
-                            "const": "sap:oauth-client-credentials:v1",
-                            "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)."
-                        },
-                        {
-                            "const": "sap:cmp-mtls:v1",
-                            "description": "The ORD information are accessible via Unified Customer Landscape's client certificate.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-cmp-mtls-v1)."
-                        },
-                        {
-                            "const": "sap.businesshub:basic-auth:v1",
-                            "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)."
-                        },
                         {
                             "const": "custom",
                             "description": "If chosen, `customType` MUST be provided.\nIf chosen, `customDescription` SHOULD be provided."
@@ -189,7 +185,7 @@
                     "minLength": 1,
                     "description": "Human-readable description about how the access is set up, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).\n\nMUST only be provided if `type` is set to `custom`.",
                     "examples": [
-                        "To set up the access to OData APIs, please refer to the [SAP Cloud for Customer OData API](https://help.sap.com/viewer/1364b70b9cbb417ea5e2d80e966d4f49/CLOUD/en-US) help pages.\""
+                        "To set up the access to OData APIs, please refer to the [SAP Cloud for Customer OData API](https://help.sap.com/viewer/1364b70b9cbb417ea5e2d80e966d4f49/CLOUD/en-US) help pages."
                     ]
                 }
             },