@open-resource-discovery/specification 1.12.3-rc2 → 1.12.3

package/dist/generated/spec/v1/schemas/configuration.schema.json

@@ -0,0 +1,212 @@
+{
+    "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/).",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#",
+    "title": "Ord Configuration",
+    "type": "object",
+    "properties": {
+        "$schema": {
+            "type": "string",
+            "format": "uri-reference",
+            "description": "Optional URL to the ORD Configuration schema (defined as JSON Schema).\nIf given, this enables code intelligence and validation in supported editors (like VSCode) and tools.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "format": "uri-reference"
+                },
+                {
+                    "const": "https://open-resource-discovery.github.io/specification/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.",
+            "pattern": "^http[s]?:\\/\\/[^:\\/\\s]+\\.[^:\\/\\s\\.]+(:\\d+)?(\\/[a-zA-Z0-9-\\._~]+)*$",
+            "examples": [
+                "https://example-sap-system.com",
+                "https://sub.foo.bar.com",
+                "https://sub.foo.bar.com/api/v1"
+            ]
+        },
+        "openResourceDiscoveryV1": {
+            "$ref": "#/definitions/OpenResourceDiscoveryV1"
+        }
+    },
+    "additionalProperties": false,
+    "required": [
+        "openResourceDiscoveryV1"
+    ],
+    "definitions": {
+        "OpenResourceDiscoveryV1": {
+            "type": "object",
+            "title": "Ord V1 Support",
+            "description": "The existence of this version indicates that Open Resource Discovery is supported in Version 1.x",
+            "properties": {
+                "documents": {
+                    "type": "array",
+                    "description": "List of all ORD documents that can be retrieved.\n\nWhile it is possible to describe everything in one big ORD document, for bigger services/use cases it might be preferable to split the information into multiple documents.\n\nFor more details how to implement this correctly, please refer to the [ORD configuration endpoint](../index.md#ord-configuration-endpoint) section and the [considerations on the granularity of ORD documents](../index.md#considerations-on-the-granularity-of-ord-documents).",
+                    "items": {
+                        "$ref": "#/definitions/V1DocumentDescription"
+                    }
+                },
+                "capabilities": {
+                    "$ref": "#/definitions/V1Capabilities"
+                }
+            },
+            "additionalProperties": false
+        },
+        "V1DocumentDescription": {
+            "type": "object",
+            "title": "Ord V1 Document Description",
+            "description": "Describes an [ORD Document](../index.md#ord-document) that is available for pull transport consumption.",
+            "properties": {
+                "url": {
+                    "type": "string",
+                    "format": "uri-reference",
+                    "description": "URL or relative URL to the ORD document (provided by an ORD document endpoint).\n\nIt is RECOMMENDED to provide a relative URL (to `baseUrl`).\nIf a `baseUrl` is given, the relative URLs will be resolved with it.\n\nIf the URL is not relative to the system providing this information or no well-known URI is used,\neither the baseUrl or a full URL to the document MUST be provided.",
+                    "examples": [
+                        "/open-resource-discovery/v1/documents/example1",
+                        "../../documents/example1",
+                        "https://example.com/open-resource-discovery/v1/documents/example1"
+                    ]
+                },
+                "perspective": {
+                    "type": "string",
+                    "x-introduced-in-version": "1.12.0",
+                    "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-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."
+                        },
+                        {
+                            "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."
+                        },
+                        {
+                            "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."
+                        }
+                    ],
+                    "default": "system-instance",
+                    "examples": [
+                        "system-instance"
+                    ]
+                },
+                "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.",
+                    "default": false,
+                    "examples": [
+                        true
+                    ]
+                },
+                "accessStrategies": {
+                    "type": "array",
+                    "description": "List of supported access strategies for retrieving the metadata from the ORD provider.\n\nAn ORD Consumer/ORD Aggregator MAY freely choose any of the listed strategies.",
+                    "items": {
+                        "$ref": "#/definitions/AccessStrategy"
+                    },
+                    "minItems": 1
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "url",
+                "accessStrategies"
+            ]
+        },
+        "V1Capabilities": {
+            "type": "object",
+            "title": "Ord V1 Capabilities",
+            "description": "List of capabilities that are supported by the ORD provider.",
+            "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."
+                }
+            }
+        },
+        "AccessStrategy": {
+            "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.",
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "description": "Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.",
+                    "oneOf": [
+                        {
+                            "type": "string",
+                            "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."
+                        },
+                        {
+                            "const": "open",
+                            "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)."
+                        },
+                        {
+                            "const": "basic-auth",
+                            "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."
+                        }
+                    ],
+                    "examples": [
+                        "open"
+                    ]
+                },
+                "customType": {
+                    "type": "string",
+                    "description": "If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.\n\nMUST be a valid [Specification ID](../index.md#specification-id).\n\nMUST only be provided if `type` is set to `custom`.",
+                    "pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):v([0-9]+)$",
+                    "maxLength": 255,
+                    "examples": [
+                        "sap.xref:open-local-tenant-id:v1"
+                    ]
+                },
+                "customDescription": {
+                    "type": "string",
+                    "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.\""
+                    ]
+                }
+            },
+            "additionalProperties": false,
+            "required": [
+                "type"
+            ],
+            "examples": [
+                {
+                    "type": "open"
+                },
+                {
+                    "type": "custom",
+                    "customType": "sap.xref:open-local-tenant-id:v1",
+                    "customDescription": "Custom description how to use custom access strategy"
+                }
+            ]
+        }
+    }
+}