@open-resource-discovery/specification 1.12.3 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -10
- package/dist/generated/spec/v1/schemas/{configuration.schema.json → Configuration.schema.json} +16 -24
- package/dist/generated/spec/v1/schemas/{document.schema.json → Document.schema.json} +264 -259
- package/dist/generated/spec/v1/types/{configuration.d.ts → Configuration.d.ts} +13 -21
- package/dist/generated/spec/v1/types/Configuration.js +4 -0
- package/dist/generated/spec/v1/types/{document.d.ts → Document.d.ts} +185 -119
- package/dist/generated/spec/v1/types/Document.js +4 -0
- package/dist/generated/spec/v1/types/index.d.ts +2 -2
- package/dist/generated/spec/v1/types/index.js +3 -2
- package/dist/index.js +3 -2
- package/package.json +29 -18
- package/dist/generated/spec/v1/types/configuration.js +0 -3
- package/dist/generated/spec/v1/types/document.js +0 -3
package/README.md
CHANGED
|
@@ -7,14 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Summary
|
|
9
9
|
|
|
10
|
-
Open Resource Discovery (ORD) is a protocol that **
|
|
11
|
-
It can be used to describe static documentation, but can also reflect tenant specific configuration and extensions (at run-time).
|
|
10
|
+
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.
|
|
12
11
|
|
|
13
|
-
**To learn more, have a look at the [Open Resource Discovery Specification](https://open-resource-discovery.
|
|
12
|
+
**To learn more, have a look at the [Open Resource Discovery Specification](https://open-resource-discovery.org/) documentation.**
|
|
14
13
|
|
|
15
14
|
> ℹ ORD is an open standard by SAP, currently geared towards the SAP ecosystem.
|
|
16
|
-
> However, it is
|
|
17
|
-
> The standard is extensible through extensibility attributes, custom types and policy levels.
|
|
15
|
+
> However, it is designed as a generic standard that can be used outside SAP with appropriate infrastructure (aggregators and namespace registry).
|
|
16
|
+
> The standard is extensible through extensibility attributes, custom types, and policy levels.
|
|
18
17
|
|
|
19
18
|
## Communication, Feedback & FAQ
|
|
20
19
|
|
|
@@ -26,11 +25,6 @@ The ORD standard is governed by the [Linux Foundation](https://www.linuxfoundati
|
|
|
26
25
|
|
|
27
26
|
## Resources
|
|
28
27
|
|
|
29
|
-
### Learning Material
|
|
30
|
-
|
|
31
|
-
Currently there are no public resources beside the ORD spec itself.
|
|
32
|
-
We plan to add more in the future.
|
|
33
|
-
|
|
34
28
|
### Tools and Examples
|
|
35
29
|
|
|
36
30
|
#### ORD Reference Application
|
package/dist/generated/spec/v1/schemas/{configuration.schema.json → Configuration.schema.json}
RENAMED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
-
"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.
|
|
2
|
+
"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/).",
|
|
3
3
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
4
|
-
"$id": "https://open-resource-discovery.
|
|
4
|
+
"$id": "https://open-resource-discovery.org/spec-v1/interfaces/Configuration.schema.json#",
|
|
5
5
|
"title": "Ord Configuration",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
@@ -15,14 +15,14 @@
|
|
|
15
15
|
"format": "uri-reference"
|
|
16
16
|
},
|
|
17
17
|
{
|
|
18
|
-
"const": "https://open-resource-discovery.
|
|
18
|
+
"const": "https://open-resource-discovery.org/spec-v1/interfaces/Configuration.schema.json#"
|
|
19
19
|
}
|
|
20
20
|
]
|
|
21
21
|
},
|
|
22
22
|
"baseUrl": {
|
|
23
23
|
"type": "string",
|
|
24
24
|
"format": "uri",
|
|
25
|
-
"description": "Optional [base URL](../index.md#
|
|
25
|
+
"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.",
|
|
26
26
|
"pattern": "^http[s]?:\\/\\/[^:\\/\\s]+\\.[^:\\/\\s\\.]+(:\\d+)?(\\/[a-zA-Z0-9-\\._~]+)*$",
|
|
27
27
|
"examples": [
|
|
28
28
|
"https://example-sap-system.com",
|
|
@@ -78,17 +78,21 @@
|
|
|
78
78
|
"x-feature-status": "beta",
|
|
79
79
|
"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.",
|
|
80
80
|
"oneOf": [
|
|
81
|
+
{
|
|
82
|
+
"const": "system-type",
|
|
83
|
+
"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."
|
|
84
|
+
},
|
|
81
85
|
{
|
|
82
86
|
"const": "system-version",
|
|
83
|
-
"description": "Describes the static [system-version](../index.md#
|
|
87
|
+
"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."
|
|
84
88
|
},
|
|
85
89
|
{
|
|
86
90
|
"const": "system-instance",
|
|
87
|
-
"description": "Describes the complete dynamic [system-instance](../index.md#
|
|
91
|
+
"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."
|
|
88
92
|
},
|
|
89
93
|
{
|
|
90
94
|
"const": "system-independent",
|
|
91
|
-
"description": "Describes content that is independent of [system-versions](../index.md#
|
|
95
|
+
"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."
|
|
92
96
|
}
|
|
93
97
|
],
|
|
94
98
|
"default": "system-instance",
|
|
@@ -98,7 +102,7 @@
|
|
|
98
102
|
},
|
|
99
103
|
"systemInstanceAware": {
|
|
100
104
|
"type": "boolean",
|
|
101
|
-
"description": "Whether the information in the ORD document is **system
|
|
105
|
+
"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).",
|
|
102
106
|
"default": false,
|
|
103
107
|
"examples": [
|
|
104
108
|
true
|
|
@@ -127,7 +131,7 @@
|
|
|
127
131
|
"selector": {
|
|
128
132
|
"type": "boolean",
|
|
129
133
|
"default": false,
|
|
130
|
-
"description": "Whether the ORD provider supports the optional [select parameter](../index.md#select-parameter) for retrieving the ORD config and ORD documents."
|
|
134
|
+
"description": "Whether the ORD provider supports the optional `select` parameter ([select parameter](../index.md#select-parameter)) for retrieving the ORD config and ORD documents."
|
|
131
135
|
}
|
|
132
136
|
}
|
|
133
137
|
},
|
|
@@ -139,10 +143,10 @@
|
|
|
139
143
|
"type": {
|
|
140
144
|
"type": "string",
|
|
141
145
|
"description": "Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.",
|
|
142
|
-
"
|
|
146
|
+
"anyOf": [
|
|
143
147
|
{
|
|
144
148
|
"type": "string",
|
|
145
|
-
"pattern": "^([a-z0-9
|
|
149
|
+
"pattern": "^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\\-]+):(v0|v[1-9][0-9]*)$",
|
|
146
150
|
"description": "Any valid [Specification ID](../index.md#specification-id).\nIf chosen, `customDescription` SHOULD be provided."
|
|
147
151
|
},
|
|
148
152
|
{
|
|
@@ -154,18 +158,6 @@
|
|
|
154
158
|
"description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).",
|
|
155
159
|
"x-introduced-in-version": "1.12.1"
|
|
156
160
|
},
|
|
157
|
-
{
|
|
158
|
-
"const": "sap:oauth-client-credentials:v1",
|
|
159
|
-
"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)."
|
|
160
|
-
},
|
|
161
|
-
{
|
|
162
|
-
"const": "sap:cmp-mtls:v1",
|
|
163
|
-
"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)."
|
|
164
|
-
},
|
|
165
|
-
{
|
|
166
|
-
"const": "sap.businesshub:basic-auth:v1",
|
|
167
|
-
"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)."
|
|
168
|
-
},
|
|
169
161
|
{
|
|
170
162
|
"const": "custom",
|
|
171
163
|
"description": "If chosen, `customType` MUST be provided.\nIf chosen, `customDescription` SHOULD be provided."
|
|
@@ -189,7 +181,7 @@
|
|
|
189
181
|
"minLength": 1,
|
|
190
182
|
"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`.",
|
|
191
183
|
"examples": [
|
|
192
|
-
"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
|
|
184
|
+
"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."
|
|
193
185
|
]
|
|
194
186
|
}
|
|
195
187
|
},
|