@open-resource-discovery/specification 1.12.3 → 1.14.0

package/dist/generated/spec/v1/types/{configuration.d.ts → Configuration.d.ts}

@@ -5,18 +5,18 @@
  *
  * The configuration endpoint is a [Well-Known URI](https://tools.ietf.org/html/rfc8615#section-3) discovery mechanism.
  *
- * This 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/).
+ * This 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/).
  */
 export interface OrdConfiguration {
     /**
      * Optional URL to the ORD Configuration schema (defined as JSON Schema).
      * If given, this enables code intelligence and validation in supported editors (like VSCode) and tools.
      */
-    $schema?: (string | "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Configuration.schema.json#") & string;
+    $schema?: (string | "https://open-resource-discovery.org/spec-v1/interfaces/Configuration.schema.json#") & string;
     /**
-     * Optional [base URL](../index.md#def-base-url) that can be used to resolve the relative URLs to the ORD Documents.
+     * Optional [base URL](../index.md#base-url) that can be used to resolve the relative URLs to the ORD Documents.
      *
-     * The `baseUrl` MUST not contain a leading slash.
+     * The `baseUrl` MUST NOT contain a leading slash.
      *
      * If 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.
      * This implies that either a `baseUrl` or only absolute URLs MUST be provided when no standardized well-known URI is used.
@@ -64,25 +64,17 @@ export interface OrdV1DocumentDescription {
      *
      * Please read the [article on perspectives](../concepts/perspectives) for more explanations.
      */
-    perspective?: "system-version" | "system-instance" | "system-independent";
+    perspective?: "system-type" | "system-version" | "system-instance" | "system-independent";
     /**
-     * Whether the information in the ORD document is **system instance aware**.
+     * Whether the information in the ORD document is **system-instance-aware**.
+     * This is the case when the provided ORD document potentially differs between **system instances** (e.g. due to multi-tenancy, configuration or extensibility).
      *
-     * This is the case when the provided ORD document potentially differs between **system instances**.
-     * Please note that if a system does not support multi-tenancy, most likely each system instance has its own
-     * URL and different system instances could even be deployed in a different state (version).
-     * If those conditions apply, `systemInstanceAware` MUST be set to true.
+     * If a document is system-instance-aware, an ORD aggregator MUST fetch it for _each_ **system instance** (tenant), not just once per system type.
      *
-     * An ORD aggregator that represents a system instance aware perspective MUST fetch a system instance aware ORD document,
-     * not just once per system type but once per **system instance**.
+     * This concept is now **deprecated** in favor of the more explicit `perspective` attribute.
+     * It is strongly RECOMMENDED to split metadata into separate documents for the different perspectives (static vs. dynamic).
      *
-     * Please note that you can define system instance awareness also on the level of an ORD resource.
-     * It is even possible and valid to have an ORD document that is NOT system instance aware to contain resources that are.
-     * This can be the case because the resource is described in separate resource definition formats which would change,
-     * while the ORD document itself would not change (the links to the resource definition files stay the same).
-     *
-     * If some ORD information is **system instance aware** and some is not,
-     * we RECOMMEND to split the information into separate documents and mark their system instance awareness accordingly.
+     * For a detailed explanation, see [perspectives concept page](../concepts/perspectives.md) or the [specification section](../index.md#perspectives).
      */
     systemInstanceAware?: boolean;
     /**
@@ -101,7 +93,7 @@ export interface OrdV1DocumentAccessStrategy {
     /**
      * Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.
      */
-    type: (string | "open" | "basic-auth" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
+    type: (string | "open" | "basic-auth" | "custom") & string;
     /**
      * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
      *
@@ -122,7 +114,7 @@ export interface OrdV1DocumentAccessStrategy {
  */
 export interface OrdV1Capabilities {
     /**
-     * Whether the ORD provider supports the optional [select parameter](../index.md#select-parameter) for retrieving the ORD config and ORD documents.
+     * Whether the ORD provider supports the optional `select` parameter ([select parameter](../index.md#select-parameter)) for retrieving the ORD config and ORD documents.
      */
     selector?: boolean;
     [k: string]: unknown | undefined;

package/dist/generated/spec/v1/types/Configuration.js

@@ -0,0 +1,4 @@
+"use strict";
+// AUTO-GENERATED definition files. Do not modify directly.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29uZmlndXJhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9nZW5lcmF0ZWQvc3BlYy92MS90eXBlcy9Db25maWd1cmF0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwyREFBMkQifQ==