@open-resource-discovery/specification 1.11.0 → 1.11.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
@@ -22,7 +22,7 @@ If you have feedback, questions or problems, please create a [GitHub issue](http
22
22
 
23
23
  ## Ownership and Governance
24
24
 
25
- The ORD development is driven by SAP internally, but public feedback, suggestions and contributions are welcome.
25
+ The ORD standard is governed by the [Linux Foundation](https://www.linuxfoundation.org/) / [NeoNephos](https://neonephos.org/projects/open-resource-discovery-ord/), a neutral nonprofit organization that supports the development of open-source projects and standards. See [ORD steering committee](https://github.com/open-resource-discovery/steering#readme).
26
26
 
27
27
  ## Resources
28
28
 
@@ -384,7 +384,7 @@ export interface APIResource {
384
384
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
385
385
  *
386
386
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
387
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
387
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
388
388
  *
389
389
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
390
390
  * The `version` MUST not be bumped for changes in extensions.
@@ -498,7 +498,7 @@ export interface APIResource {
498
498
  /**
499
499
  * API Protocol including the protocol version if applicable
500
500
  */
501
- apiProtocol: (string | "odata-v2" | "odata-v4" | "rest" | "graphql" | "delta-sharing" | "soap-inbound" | "soap-outbound" | "websocket" | "sap-rfc" | "sap-sql-api-v1" | "sap-ina-api-v1") & string;
501
+ apiProtocol: (string | "odata-v2" | "odata-v4" | "rest" | "graphql" | "delta-sharing" | "soap-inbound" | "soap-outbound" | "mcp" | "websocket" | "sap-rfc" | "sap-sql-api-v1" | "sap-ina-api-v1") & string;
502
502
  /**
503
503
  * List of available machine-readable definitions, which describe the resource or capability in detail.
504
504
  *
@@ -533,8 +533,8 @@ export interface APIResource {
533
533
  */
534
534
  customImplementationStandardDescription?: string;
535
535
  /**
536
- * Declares this API is a compatible implementation of the referenced API contract(s).
537
- * This is also sometimes known as [Service Provider Interface](https://en.wikipedia.org/wiki/Service_provider_interface).
536
+ * A reference to the interface (API contract) that this API implements.
537
+ * Serves as a declaration of compatible implementation of API contract, effectively functioning as an "implementationOf" relationship.
538
538
  *
539
539
  * MUST be a valid reference to an (usually external) [API Resource](#api-resource) ORD ID.
540
540
  *
@@ -594,14 +594,14 @@ export interface APIResource {
594
594
  *
595
595
  * `lineOfBusiness` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
596
596
  */
597
- lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
597
+ lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Strategy, Compliance, and Governance" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
598
598
  /**
599
599
  * List of industry tags.
600
600
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
601
601
  *
602
602
  * `industry` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
603
603
  */
604
- industry?: ((string | "Aerospace and Defense" | "Automotive" | "Banking" | "Chemicals" | "Consumer Products" | "Defense and Security" | "Engineering Construction and Operations" | "Healthcare" | "Higher Education and Research" | "High Tech" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Retail" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
604
+ industry?: ((string | "Aerospace and Defense" | "Agribusiness" | "Automotive" | "Banking" | "Chemicals" | "Consumer Industries" | "Consumer Products" | "Defense and Security" | "Discrete Industries" | "Energy and Natural Resources" | "Engineering Construction and Operations" | "Financial Services" | "Future Cities" | "Healthcare" | "High Tech" | "Higher Education and Research" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Public Services" | "Retail" | "Service Industries" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
605
605
  /**
606
606
  * List of free text style tags.
607
607
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
@@ -711,7 +711,7 @@ export interface APIResourceDefinition {
711
711
  * Type of the API Resource Definition
712
712
  * If "custom" is chosen, a customType MUST be provided
713
713
  */
714
- type: (string | "openapi-v2" | "openapi-v3" | "raml-v1" | "edmx" | "csdl-json" | "graphql-sdl" | "wsdl-v1" | "wsdl-v2" | "sap-rfc-metadata-v1" | "sap-sql-api-definition-v1" | "sap-csn-interop-effective-v1" | "custom") & string;
714
+ type: (string | "openapi-v2" | "openapi-v3" | "openapi-v3.1+" | "raml-v1" | "edmx" | "csdl-json" | "graphql-sdl" | "wsdl-v1" | "wsdl-v2" | "sap-rfc-metadata-v1" | "sap-sql-api-definition-v1" | "sap-csn-interop-effective-v1" | "custom") & string;
715
715
  /**
716
716
  * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
717
717
  *
@@ -1088,7 +1088,7 @@ export interface EventResource {
1088
1088
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
1089
1089
  *
1090
1090
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
1091
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1091
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1092
1092
  *
1093
1093
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
1094
1094
  * The `version` MUST not be bumped for changes in extensions.
@@ -1256,14 +1256,14 @@ export interface EventResource {
1256
1256
  *
1257
1257
  * `lineOfBusiness` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
1258
1258
  */
1259
- lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
1259
+ lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Strategy, Compliance, and Governance" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
1260
1260
  /**
1261
1261
  * List of industry tags.
1262
1262
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
1263
1263
  *
1264
1264
  * `industry` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
1265
1265
  */
1266
- industry?: ((string | "Aerospace and Defense" | "Automotive" | "Banking" | "Chemicals" | "Consumer Products" | "Defense and Security" | "Engineering Construction and Operations" | "Healthcare" | "Higher Education and Research" | "High Tech" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Retail" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
1266
+ industry?: ((string | "Aerospace and Defense" | "Agribusiness" | "Automotive" | "Banking" | "Chemicals" | "Consumer Industries" | "Consumer Products" | "Defense and Security" | "Discrete Industries" | "Energy and Natural Resources" | "Engineering Construction and Operations" | "Financial Services" | "Future Cities" | "Healthcare" | "High Tech" | "Higher Education and Research" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Public Services" | "Retail" | "Service Industries" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
1267
1267
  /**
1268
1268
  * List of free text style tags.
1269
1269
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
@@ -1445,7 +1445,7 @@ export interface EntityType {
1445
1445
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
1446
1446
  *
1447
1447
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
1448
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1448
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1449
1449
  *
1450
1450
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
1451
1451
  * The `version` MUST not be bumped for changes in extensions.
@@ -1681,7 +1681,7 @@ export interface Capability {
1681
1681
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
1682
1682
  *
1683
1683
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
1684
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1684
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1685
1685
  *
1686
1686
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
1687
1687
  * The `version` MUST not be bumped for changes in extensions.
@@ -1905,7 +1905,7 @@ export interface DataProduct {
1905
1905
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
1906
1906
  *
1907
1907
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
1908
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1908
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
1909
1909
  *
1910
1910
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
1911
1911
  * The `version` MUST not be bumped for changes in extensions.
@@ -2051,14 +2051,14 @@ export interface DataProduct {
2051
2051
  *
2052
2052
  * `industry` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
2053
2053
  */
2054
- industry?: ((string | "Aerospace and Defense" | "Automotive" | "Banking" | "Chemicals" | "Consumer Products" | "Defense and Security" | "Engineering Construction and Operations" | "Healthcare" | "Higher Education and Research" | "High Tech" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Retail" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
2054
+ industry?: ((string | "Aerospace and Defense" | "Agribusiness" | "Automotive" | "Banking" | "Chemicals" | "Consumer Industries" | "Consumer Products" | "Defense and Security" | "Discrete Industries" | "Energy and Natural Resources" | "Engineering Construction and Operations" | "Financial Services" | "Future Cities" | "Healthcare" | "High Tech" | "Higher Education and Research" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Public Services" | "Retail" | "Service Industries" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
2055
2055
  /**
2056
2056
  * List of line of business tags.
2057
2057
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
2058
2058
  *
2059
2059
  * `lineOfBusiness` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
2060
2060
  */
2061
- lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
2061
+ lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Strategy, Compliance, and Governance" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
2062
2062
  /**
2063
2063
  * List of countries that the package resources are applicable to.
2064
2064
  *
@@ -2257,7 +2257,7 @@ export interface IntegrationDependency {
2257
2257
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
2258
2258
  *
2259
2259
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
2260
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2260
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2261
2261
  *
2262
2262
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
2263
2263
  * The `version` MUST not be bumped for changes in extensions.
@@ -2615,7 +2615,7 @@ export interface Package {
2615
2615
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
2616
2616
  *
2617
2617
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
2618
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2618
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2619
2619
  *
2620
2620
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
2621
2621
  * The `version` MUST not be bumped for changes in extensions.
@@ -2710,14 +2710,14 @@ export interface Package {
2710
2710
  *
2711
2711
  * `lineOfBusiness` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
2712
2712
  */
2713
- lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
2713
+ lineOfBusiness?: ((string | "Asset Management" | "Commerce" | "Finance" | "Human Resources" | "Manufacturing" | "Marketing" | "R&D Engineering" | "Sales" | "Service" | "Sourcing and Procurement" | "Strategy, Compliance, and Governance" | "Supply Chain" | "Sustainability" | "Metering" | "Grid Operations and Maintenance" | "Plant Operations and Maintenance" | "Maintenance and Engineering") & string)[];
2714
2714
  /**
2715
2715
  * List of industry tags.
2716
2716
  * No special characters are allowed except `-`, `_`, `.`, `/` and ` `.
2717
2717
  *
2718
2718
  * `industry` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
2719
2719
  */
2720
- industry?: ((string | "Aerospace and Defense" | "Automotive" | "Banking" | "Chemicals" | "Consumer Products" | "Defense and Security" | "Engineering Construction and Operations" | "Healthcare" | "Higher Education and Research" | "High Tech" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Retail" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
2720
+ industry?: ((string | "Aerospace and Defense" | "Agribusiness" | "Automotive" | "Banking" | "Chemicals" | "Consumer Industries" | "Consumer Products" | "Defense and Security" | "Discrete Industries" | "Energy and Natural Resources" | "Engineering Construction and Operations" | "Financial Services" | "Future Cities" | "Healthcare" | "High Tech" | "Higher Education and Research" | "Industrial Machinery and Components" | "Insurance" | "Life Sciences" | "Media" | "Mill Products" | "Mining" | "Oil and Gas" | "Professional Services" | "Public Sector" | "Public Services" | "Retail" | "Service Industries" | "Sports and Entertainment" | "Telecommunications" | "Travel and Transportation" | "Utilities" | "Wholesale Distribution") & string)[];
2721
2721
  /**
2722
2722
  * If provided, all resources that are part of this package can only run on the listed runtime.
2723
2723
  *
@@ -2825,7 +2825,7 @@ export interface ConsumptionBundle {
2825
2825
  * It SHOULD express minor and patch changes that don't lead to incompatible changes.
2826
2826
  *
2827
2827
  * When the `version` major version changes, the [ORD ID](../index.md#ord-id) `<majorVersion>` fragment MUST be updated to be identical.
2828
- * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://swagger.io/specification/#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2828
+ * In case that a resource definition file also contains a version number (e.g. [OpenAPI `info`.`version`](https://spec.openapis.org/oas/v3.1.1.html#info-object)), it MUST be equal with the resource `version` to avoid inconsistencies.
2829
2829
  *
2830
2830
  * If the resource has been extended by the user, the change MUST be indicated via `lastUpdate`.
2831
2831
  * The `version` MUST not be bumped for changes in extensions.
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.11.0",
4
+ "version": "1.11.1",
5
5
  "description": "Open Resource Discovery (ORD) Specification",
6
6
  "author": "SAP SE",
7
7
  "license": "Apache-2.0",
@@ -26,9 +26,9 @@
26
26
  "deploy": "npm run build && gh-pages -d ./build"
27
27
  },
28
28
  "devDependencies": {
29
- "@docusaurus/core": "3.8.0",
30
- "@docusaurus/preset-classic": "3.8.0",
31
- "@docusaurus/theme-mermaid": "3.8.0",
29
+ "@docusaurus/core": "3.8.1",
30
+ "@docusaurus/preset-classic": "3.8.1",
31
+ "@docusaurus/theme-mermaid": "3.8.1",
32
32
  "@easyops-cn/docusaurus-search-local": "0.49.2",
33
33
  "@mdx-js/react": "3.1.0",
34
34
  "clsx": "2.1.1",