@open-resource-discovery/specification 1.12.0 → 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 CHANGED
@@ -53,3 +53,9 @@ For detailed and recent changes, please refer to the [CHANGELOG.md](CHANGELOG.md
53
53
  ## License
54
54
 
55
55
  Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/open-resource-discovery/specification).
56
+
57
+ ## Open Resource Discovery and NeoNephos
58
+
59
+ Open Resource Discovery has been donated to the NeoNephos Foundation, a Linux Foundation initiative dedicated to advancing open-source projects that align with the strategic objectives of IPCEI-CIS under neutral governance. Learn more about NeoNephos and our role within it [here](https://neonephos.org/).
60
+
61
+ <p align="center"><img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/></p>
@@ -99,7 +99,7 @@ export interface AccessStrategy {
99
99
  /**
100
100
  * Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.
101
101
  */
102
- type: (string | "open" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
102
+ type: (string | "open" | "basic-auth" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
103
103
  /**
104
104
  * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
105
105
  *
@@ -213,7 +213,7 @@ export interface DocumentationLabels {
213
213
  */
214
214
  export interface SystemType {
215
215
  /**
216
- * The system namespace is a unique identifier for the system type.
216
+ * The [system namespace](../index.md#system-namespace) is a unique identifier for the system type.
217
217
  * It is used to reference the system type in the ORD.
218
218
  */
219
219
  systemNamespace?: string;
@@ -774,7 +774,7 @@ export interface AccessStrategy {
774
774
  /**
775
775
  * Defines the authentication/authorization strategy through which the referenced `resourceDefinitions` are accessible.
776
776
  */
777
- type: (string | "open" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
777
+ type: (string | "open" | "basic-auth" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
778
778
  /**
779
779
  * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
780
780
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package",
3
3
  "name": "@open-resource-discovery/specification",
4
- "version": "1.12.0",
4
+ "version": "1.12.1",
5
5
  "description": "Open Resource Discovery (ORD) Specification",
6
6
  "author": "SAP SE",
7
7
  "license": "Apache-2.0",
@@ -29,8 +29,8 @@
29
29
  "@docusaurus/core": "3.8.1",
30
30
  "@docusaurus/preset-classic": "3.8.1",
31
31
  "@docusaurus/theme-mermaid": "3.8.1",
32
- "@easyops-cn/docusaurus-search-local": "0.51.1",
33
- "@mdx-js/react": "3.1.0",
32
+ "@easyops-cn/docusaurus-search-local": "0.52.1",
33
+ "@mdx-js/react": "3.1.1",
34
34
  "clsx": "2.1.1",
35
35
  "prism-react-renderer": "2.4.1",
36
36
  "react": "18.3.1",
@@ -116,6 +116,11 @@
116
116
  "const": "open",
117
117
  "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)."
118
118
  },
119
+ {
120
+ "const": "basic-auth",
121
+ "description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).",
122
+ "x-introduced-in-version": "1.12.1"
123
+ },
119
124
  {
120
125
  "const": "sap:oauth-client-credentials:v1",
121
126
  "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)."
@@ -126,7 +131,9 @@
126
131
  },
127
132
  {
128
133
  "const": "sap.businesshub:basic-auth:v1",
129
- "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)."
134
+ "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).",
135
+ "x-deprecated-in-version": "1.12.1",
136
+ "x-deprecated": "This access strategy is deprecated and will be removed in a future version of the specification.\nPlease use `basic-auth` instead."
130
137
  },
131
138
  {
132
139
  "const": "custom",
@@ -112,6 +112,10 @@
112
112
  "const": "open",
113
113
  "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)."
114
114
  },
115
+ {
116
+ "const": "basic-auth",
117
+ "description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth)."
118
+ },
115
119
  {
116
120
  "const": "sap:oauth-client-credentials:v1",
117
121
  "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)."
@@ -5007,8 +5007,9 @@
5007
5007
  "properties": {
5008
5008
  "systemNamespace": {
5009
5009
  "type": "string",
5010
- "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.",
5011
5011
  "pattern": "^[a-z0-9]+(?:[.][a-z0-9]+){1}$",
5012
+ "maxLength": 32,
5012
5013
  "examples": [
5013
5014
  "sap.s4",
5014
5015
  "sap.c4c",
@@ -5134,6 +5135,11 @@
5134
5135
  "const": "open",
5135
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)."
5136
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
+ },
5137
5143
  {
5138
5144
  "const": "sap:oauth-client-credentials:v1",
5139
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)."
@@ -5144,7 +5150,9 @@
5144
5150
  },
5145
5151
  {
5146
5152
  "const": "sap.businesshub:basic-auth:v1",
5147
- "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."
5148
5156
  },
5149
5157
  {
5150
5158
  "const": "custom",
@@ -4622,8 +4622,9 @@
4622
4622
  "properties": {
4623
4623
  "systemNamespace": {
4624
4624
  "type": "string",
4625
- "description": "The system namespace is a unique identifier for the system type.\nIt is used to reference the system type in the ORD.",
4625
+ "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.",
4626
4626
  "pattern": "^[a-z0-9]+(?:[.][a-z0-9]+){1}$",
4627
+ "maxLength": 32,
4627
4628
  "examples": [
4628
4629
  "sap.s4",
4629
4630
  "sap.c4c",
@@ -4743,6 +4744,10 @@
4743
4744
  "const": "open",
4744
4745
  "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)."
4745
4746
  },
4747
+ {
4748
+ "const": "basic-auth",
4749
+ "description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth)."
4750
+ },
4746
4751
  {
4747
4752
  "const": "sap:oauth-client-credentials:v1",
4748
4753
  "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)."