@open-resource-discovery/specification 1.10.0 → 1.10.1

package/README.md

@@ -1,4 +1,5 @@
 [![REUSE status](https://api.reuse.software/badge/github.com/open-resource-discovery/specification)](https://api.reuse.software/info/github.com/open-resource-discovery/specification)
+<a href="https://www.npmjs.com/package/@open-resource-discovery/specification"><img src="https://img.shields.io/npm/v/@open-resource-discovery/specification" alt="NPM package"></a>
 
 # Open Resource Discovery Specification
 
@@ -47,7 +48,7 @@ For detailed and recent changes, please refer to the [CHANGELOG.md](CHANGELOG.md
 ## Acknowledgements
 
 - The original idea for ORD came from Harsh Jegadeesan and Divya Mary.
-- The currently active core-contributors to the spec are: [Simon Heimler](https://github.com/Fannon), [Sebastian Wennemers](https://github.com/swennemers), [Steffen Göbel](https://github.com/steffengoebel), [Ralf Hofmann](https://github.com/ormos), [Kiril Kabakchiev](https://github.com/KirilKabakchiev), [Nikolay Mateev](https://github.com/NickyMateev), [Bibin Thomas](https://github.com/Bibin-T) and others.
+- The currently active core-contributors to the spec are: [Simon Heimler](https://github.com/Fannon), [Sebastian Wennemers](https://github.com/swennemers), [Pavel Kornev](https://github.com/pavelkornev), [Steffen Göbel](https://github.com/steffengoebel), [Ralf Hofmann](https://github.com/ormos), [Kiril Kabakchiev](https://github.com/KirilKabakchiev), [Nikolay Mateev](https://github.com/NickyMateev), [Bibin Thomas](https://github.com/Bibin-T) and others.
 
 ## License
 

package/dist/types/v1/Document.d.ts

@@ -283,9 +283,11 @@ export interface APIResource {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -365,7 +367,7 @@ export interface APIResource {
      */
     defaultConsumptionBundle?: string;
     /**
-     * List of products this resource is a part of.
+     * List of products the resources of the package are a part of.
      *
      * MUST be a valid reference to a [Product](#product) ORD ID.
      *
@@ -788,7 +790,7 @@ export interface AccessStrategy {
  * To indicate this, the service needs to be implemented and described in ORD with `implementationStandard` set to `sap:csn-exposure:v1`).
  *
  * ODM 2.0 relies on the entity type mappings and uses the the mapping to express the relationship of an API to the
- * corresponding ODM entity. ORD consumers like SAP Business Accelerator Hub consume the mapping to make the relationships navigatable for customers.
+ * corresponding ODM entity. ORD consumers like SAP Business Accelerator Hub consume the mapping to make the relationships navigate-able for customers.
  */
 export interface EntityTypeMapping {
     /**
@@ -966,9 +968,11 @@ export interface EventResource {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -1048,7 +1052,7 @@ export interface EventResource {
      */
     defaultConsumptionBundle?: string;
     /**
-     * List of products this resource is a part of.
+     * List of products the resources of the package are a part of.
      *
      * MUST be a valid reference to a [Product](#product) ORD ID.
      *
@@ -1338,9 +1342,11 @@ export interface EntityType {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId: string;
     /**
@@ -1395,7 +1401,7 @@ export interface EntityType {
      */
     partOfGroups?: string[];
     /**
-     * List of products this resource is a part of.
+     * List of products the resources of the package are a part of.
      *
      * MUST be a valid reference to a [Product](#product) ORD ID.
      *
@@ -1570,9 +1576,11 @@ export interface Capability {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -1795,9 +1803,11 @@ export interface DataProduct {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -1851,6 +1861,16 @@ export interface DataProduct {
      * All resources that share the same group ID assignment are effectively grouped together.
      */
     partOfGroups?: string[];
+    /**
+     * List of products this Data Product is a part of or is related to, its e.g. data source systems.
+     *
+     * MUST be a valid reference to a [Product](#product) ORD ID.
+     *
+     * `partOfProducts` that are assigned to a `Package` are inherited to all of the ORD resources it contains.
+     *
+     * @minItems 0
+     */
+    partOfProducts?: string[];
     /**
      * The complete [SemVer](https://semver.org/) version string.
      *
@@ -2145,9 +2165,11 @@ export interface IntegrationDependency {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -2531,9 +2553,11 @@ export interface Package {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**
@@ -2637,7 +2661,7 @@ export interface Package {
      */
     vendor: string;
     /**
-     * List of products this resource is a part of.
+     * List of products the resources of the package are a part of.
      *
      * MUST be a valid reference to a [Product](#product) ORD ID.
      *
@@ -2729,9 +2753,11 @@ export interface ConsumptionBundle {
      */
     ordId: string;
     /**
-     * Local ID, as known by the described system.
+     * The locally unique ID under which this resource can be looked up / resolved in the described system itself.
+     * Unlike the ORD ID it's not globally unique, but it may be useful to document the original ID / technical name.
      *
-     * This can be the `<resourceName>` fragment in the ORD ID. In this case, make sure it fits the length limits of the ORD ID. It might also be different if e.g. localIds have incompatible charset restrictions.
+     * It MAY also be used as the `<resourceName>` fragment in the ORD ID, IF it can fulfill the charset and length limitations within the ORD ID.
+     * But since this is not always possible, no assumptions MUST be made about the local ID being the same as the `<resourceName>` fragment in the ORD ID.
      */
     localId?: string;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package",
   "name": "@open-resource-discovery/specification",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "description": "Open Resource Discovery (ORD) Specification",
   "author": "SAP SE",
   "license": "Apache-2.0",
@@ -29,7 +29,7 @@
     "@docusaurus/core": "3.7.0",
     "@docusaurus/preset-classic": "3.7.0",
     "@docusaurus/theme-mermaid": "3.7.0",
-    "@easyops-cn/docusaurus-search-local": "0.49.1",
+    "@easyops-cn/docusaurus-search-local": "0.49.2",
     "@mdx-js/react": "3.1.0",
     "clsx": "2.1.1",
     "prism-react-renderer": "2.4.1",

package/static/spec-v1/interfaces/Configuration.annotated.schema.json

@@ -2,6 +2,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.",
   "$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",
   "definitions": {
     "OpenResourceDiscoveryV1": {
       "type": "object",
@@ -124,7 +125,6 @@
       ]
     }
   },
-  "title": "ORD Configuration",
   "type": "object",
   "properties": {
     "$schema": {

package/static/spec-v1/interfaces/Configuration.schema.json

@@ -1,6 +1,7 @@
 {
   "$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",
   "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.",
   "definitions": {
     "OpenResourceDiscoveryV1": {
@@ -124,7 +125,6 @@
       ]
     }
   },
-  "title": "ORD Configuration",
   "type": "object",
   "properties": {
     "$schema": {