v1.12.1 release

Author: Fannon

CHANGELOG.md

@@ -10,6 +10,18 @@ For a roadmap including expected timeline, please refer to [ROADMAP.md](./ROADMA
 
 ## [unreleased]
 
+## [1.12.1]
+
+### Added
+
+- Added `basic-auth` access strategy for generic basic authentication
+  - Deprecated `sap.businesshub:basic-auth:v1` access strategy in favor of `basic-auth`
+
+### Changed
+
+- Added explicit max length constrain to `systemNamespace` (32 chars)
+  - This was already stated in the specification, but not enforced in the JSON Schema
+
 ## [1.12.0]
 
 ### Added

dist/types/v1/Configuration.d.ts

@@ -99,7 +99,7 @@ export interface AccessStrategy {
     /**
      * Defines the authentication/authorization strategy through which the referenced ORD Documents can be accessed.
      */
-    type: (string | "open" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
+    type: (string | "open" | "basic-auth" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
     /**
      * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
      *

dist/types/v1/Document.d.ts

@@ -213,7 +213,7 @@ export interface DocumentationLabels {
  */
 export interface SystemType {
     /**
-     * The system namespace is a unique identifier for the system type.
+     * The [system namespace](../index.md#system-namespace) is a unique identifier for the system type.
      * It is used to reference the system type in the ORD.
      */
     systemNamespace?: string;
@@ -774,7 +774,7 @@ export interface AccessStrategy {
     /**
      * Defines the authentication/authorization strategy through which the referenced `resourceDefinitions` are accessible.
      */
-    type: (string | "open" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
+    type: (string | "open" | "basic-auth" | "sap:oauth-client-credentials:v1" | "sap:cmp-mtls:v1" | "sap.businesshub:basic-auth:v1" | "custom") & string;
     /**
      * If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.
      *

docs/spec-extensions/access-strategies/basic-auth.md

@@ -0,0 +1,55 @@
+---
+title: Basic Auth Access Strategy
+description: Generic basic auth authentication and authorization.
+sidebar_position: 1
+---
+
+# Basic Auth Access Strategy
+
+## Description
+
+The `basic-auth` access strategy is a generic access strategy that uses basic authentication for authentication and authorization.
+It doesn't specify how the credentials would be exchanged.
+
+To send Basic Authentication with HTTP requests, you include an Authorization header with your request.
+The header value is the word `Basic`, followed by a space, then a Base64-encoded string of `username:password`.
+
+The `accessStrategy`.`type` value for it is: `basic-auth`.
+
+## Optional Tenant HTTP Headers
+
+It may be necessary to indicate which tenant the information are requested for.
+This becomes necessary when the ORD Provider is multi-tenant and the metadata it provides is different across those tenants (system instance aware).
+
+The HTTP headers are optional and will only be sent by the ORD Aggregator if they are applicable and known by it.
+
+If the ORD Provider has metadata that is different per tenant and it understands the provided tenant IDs, it MUST return the ORD related information and metadata for the chosen tenant.
+
+> ℹ Please note that according to [RFC 7230 Section 3.2](https://www.rfc-editor.org/rfc/rfc7230#section-3.2) HTTP headers are case insensitive.
+
+### Local-Tenant-Id
+
+The local tenant ID is the ID that the system instance itself created and uses to identify its tenants.
+It is passed along as a `Local-Tenant-Id` header.
+
+```http
+GET /.well-known/open-resource-discovery/document/1
+Content-Type: application/json
+Local-Tenant-Id: 000023
+```
+
+### Global-Tenant-Id
+
+The global tenant ID is a globally unique ID for a system instance (tenant). The scope of uniqueness is within the connected aggregator.
+It is passed along as a `Global-Tenant-Id` header.
+
+```http
+GET /.well-known/open-resource-discovery/document/1
+Content-Type: application/json
+Global-Tenant-Id: c6c80b52-ecc1-47f8-9303-0d55fb67fd41
+```
+
+### General Remarks
+
+> ℹ If the metadata is not different across tenants (system instance unaware), the response is static and the same across tenants.
+> In this case, this should be indicated via `systemInstanceAware`: `false` to avoid unnecessary requests for each tenant.

docs/spec-extensions/access-strategies/open.md

@@ -4,7 +4,7 @@ description: Access without mandatory authentication and authorization.
 sidebar_position: 0
 ---
 
-# Open Access Strategy (v1.0)
+# Open Access Strategy
 
 ## Description
 

docs/spec-extensions/access-strategies/sap-businesshub-basic-v1.md

@@ -8,6 +8,8 @@ sidebar_position: 3
 
 ## Description
 
+**DEPRECATED**: This access strategy is deprecated and will be removed in a future version of the specification. Please use [`basic-auth`](./basic-auth.md) instead.
+
 This is an SAP internal access strategy that is used for publishing to the [SAP Business Accelerator Hub](https://api.sap.com/), which is used to describe the generic, static catalog perspective.
 
 The [Specification ID](../../spec-v1/index.md#specification-id) for it is: `sap.businesshub:basic-auth:v1`.

docs/spec-v1/interfaces/document.md

@@ -839,7 +839,7 @@ A [system type](../index.md#def-system-type) is the abstract type of an applicat
 
 | Property | Type | Description |
 | -------- | ---- | ----------- |
-|<div className="interface-property-name anchor" id="system-type_systemnamespace">systemNamespace<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#system-type_systemnamespace" title="SystemType.systemNamespace"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">The system namespace is a unique identifier for the system type.<br/>It is used to reference the system type in the ORD.<br/><hr/><strong>Regex Pattern</strong>: <code className="regex">^\[a-z0-9\]+(?:\[.\]\[a-z0-9\]+){1}$</code><br/><strong>Example Values</strong>: <ul className="examples"><li>`"sap.s4"`</li><li>`"sap.c4c"`</li><li>`"sap.cld"`</li></ul></div>|
+|<div className="interface-property-name anchor" id="system-type_systemnamespace">systemNamespace<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#system-type_systemnamespace" title="SystemType.systemNamespace"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">The [system namespace](../index.md#system-namespace) is a unique identifier for the system type.<br/>It is used to reference the system type in the ORD.<br/><hr/><strong>Regex Pattern</strong>: <code className="regex">^\[a-z0-9\]+(?:\[.\]\[a-z0-9\]+){1}$</code><br/><strong>Maximum Length</strong>: `32`<br/><strong>Example Values</strong>: <ul className="examples"><li>`"sap.s4"`</li><li>`"sap.c4c"`</li><li>`"sap.cld"`</li></ul></div>|
 |<div className="interface-property-name anchor" id="system-type_correlationids">correlationIds<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#system-type_correlationids" title="SystemType.correlationIds"></a></div>|<div className="interface-property-type">Array&lt;string&gt;</div>|<div className="interface-property-description">Correlation IDs can be used to create a reference to related data in other repositories (especially to the system of record).<br/><br/>They express an "identity" / "equals" / "mappable" relationship to the target ID.<br/><br/>If a "part of" relationship needs to be expressed, use the `partOfGroups` assignment instead.<br/><br/>MUST be a valid [Correlation ID](../index.md#correlation-id).<br/><hr/><strong>Array Item Regex Pattern</strong>: <code className="regex">^(\[a-z0-9\]+(?:\[.\]\[a-z0-9\]+)\*):(\[a-zA-Z0-9.\_\\-\\/\]+):(\[a-zA-Z0-9.\_\\-\\/\]+)$</code><br/><strong>Example Values</strong>: <ul className="examples"><li>`["sap.cld:systemRole:S4_PC"]`</li></ul></div>|
 |<div className="interface-property-name anchor" id="system-type_labels">labels<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#system-type_labels" title="SystemType.labels"></a></div>|<div className="interface-property-type">[Labels](#labels)</div>|<div className="interface-property-description">Generic labels that can be applied to most ORD information.<br/></div>|
 |<div className="interface-property-name anchor" id="system-type_documentationlabels">documentationLabels<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#system-type_documentationlabels" title="SystemType.documentationLabels"></a></div>|<div className="interface-property-type">[Documentation Labels](#documentation-labels)</div>|<div className="interface-property-description">Generic documentation labels that can be applied to most ORD information.<br/></div>|
@@ -869,7 +869,7 @@ Defines the [access strategy](../../spec-extensions/access-strategies/) for acce
 
 | Property | Type | Description |
 | -------- | ---- | ----------- |
-|<div className="interface-property-name anchor" id="access-strategy_type">type<br/><span className="mandatory">MANDATORY</span><a className="hash-link" href="#access-strategy_type" title="AccessStrategy.type"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">Defines the authentication/authorization strategy through which the referenced `resourceDefinitions` are accessible.<br/><hr/><strong>Allowed Values</strong> (extensible): <ul><li><em>Any</em> string: Any valid [Specification ID](../index.md#specification-id).<br/>If chosen, `customDescription` SHOULD be provided.</li><li>`"open"`: The resource definitions are openly accessible and not protected via authentication or authorization.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/open).</li><li>`"sap:oauth-client-credentials:v1"`: The ORD information are accessible via OAuth 2.0 client credentials flow as standardized within SAP.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-oauth-client-credentials-v1).</li><li>`"sap:cmp-mtls:v1"`: The ORD information are accessible via Unified Customer Landscape's client certificate.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-cmp-mtls-v1).</li><li>`"sap.businesshub:basic-auth:v1"`: The ORD information are accessible for SAP Business Accelerator Hub via Basic Auth strategy.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-businesshub-basic-v1).</li><li>`"custom"`: If chosen, `customType` MUST be provided.<br/>If chosen, `customDescription` SHOULD be provided.</li></ul><br/><strong>Example Values</strong>: <ul className="examples"><li>`"open"`</li></ul></div>|
+|<div className="interface-property-name anchor" id="access-strategy_type">type<br/><span className="mandatory">MANDATORY</span><a className="hash-link" href="#access-strategy_type" title="AccessStrategy.type"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">Defines the authentication/authorization strategy through which the referenced `resourceDefinitions` are accessible.<br/><hr/><strong>Allowed Values</strong> (extensible): <ul><li><em>Any</em> string: Any valid [Specification ID](../index.md#specification-id).<br/>If chosen, `customDescription` SHOULD be provided.</li><li>`"open"`: The resource definitions are openly accessible and not protected via authentication or authorization.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/open).</li><li>`"basic-auth"`: The resource definitions are protected via generic basic auth.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).</li><li>`"sap:oauth-client-credentials:v1"`: The ORD information are accessible via OAuth 2.0 client credentials flow as standardized within SAP.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-oauth-client-credentials-v1).</li><li>`"sap:cmp-mtls:v1"`: The ORD information are accessible via Unified Customer Landscape's client certificate.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-cmp-mtls-v1).</li><li>`"sap.businesshub:basic-auth:v1"`: The ORD information are accessible for SAP Business Accelerator Hub via Basic Auth strategy.<br/>Please find a more detailed documentation [here](../../spec-extensions/access-strategies/sap-businesshub-basic-v1).</li><li>`"custom"`: If chosen, `customType` MUST be provided.<br/>If chosen, `customDescription` SHOULD be provided.</li></ul><br/><strong>Example Values</strong>: <ul className="examples"><li>`"open"`</li></ul></div>|
 |<div className="interface-property-name anchor" id="access-strategy_customtype">customType<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#access-strategy_customtype" title="AccessStrategy.customType"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">If the fixed `type` enum values need to be extended, an arbitrary `customType` can be provided.<br/><br/>MUST be a valid [Specification ID](../index.md#specification-id).<br/><br/>MUST only be provided if `type` is set to `custom`.<br/><hr/><strong>Regex Pattern</strong>: <code className="regex">^(\[a-z0-9\]+(?:\[.\]\[a-z0-9\]+)\*):(\[a-zA-Z0-9.\_\\-\]+):(v0\|v\[1-9\]\[0-9\]\*)$</code><br/><strong>Maximum Length</strong>: `255`<br/><strong>Example Values</strong>: <ul className="examples"><li>`"sap.xref:open-local-tenant-id:v1"`</li></ul></div>|
 |<div className="interface-property-name anchor" id="access-strategy_customdescription">customDescription<br/><span className="optional">OPTIONAL</span><a className="hash-link" href="#access-strategy_customdescription" title="AccessStrategy.customDescription"></a></div>|<div className="interface-property-type">string</div>|<div className="interface-property-description">Human-readable description about how the access is set up, notated in [CommonMark](https://spec.commonmark.org/) (Markdown).<br/><br/>MUST only be provided if `type` is set to `custom`.<br/><hr/><strong>Minimum Length</strong>: `1`<br/><strong>Example Values</strong>: <ul className="examples"><li>`"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.\""`</li></ul></div>|
 

package.json

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

static/css/custom.css

@@ -437,7 +437,7 @@ html[data-nav-scrolled="1"] .header-github-pill {
   width: 160px;
   height: 32px;
   border-radius: 8px;
-  padding: 5px 8px;
+  margin: 3px 8px;
   display: flex;
   align-items: center;
   justify-content: space-between;
@@ -449,7 +449,7 @@ html[data-nav-scrolled="1"] .header-github-pill {
 .navbar :is(input.navbar__search-input, input[class*="searchInput_"]) {
   flex: 1;
   min-width: 0;
-  padding-left: 22px;
+  padding-left: 30px;
   background: transparent !important;
   color: #e0e6ea !important;
   border: 0;
@@ -496,9 +496,11 @@ html[data-nav-scrolled="1"] .header-github-pill {
   height: 100%;
   background: url("../img/icons/cmd-k.svg") center/contain no-repeat;
 }
-/*Clear (X) icon*/
-.searchClearButton {
+
+/* Clear (X) icon */
+[class*="searchClearButton"] {
   filter: invert(1);
+  opacity: 0.9;
 }
 
 /* ===== navbar states ===== */
@@ -514,11 +516,13 @@ html:not([data-nav-scrolled="1"]) #__docusaurus:has(.ord-home-flag) .navbar::bef
 
 /* Inner pages: glass */
 #__docusaurus:not(:has(.ord-home-flag)) .navbar {
-  background-color: rgba(var(--bg-rgb), var(--glass-alpha)) !important;
+  background-color: var(--lp-c-bg) !important;
+  opacity: var(--glass-alpha);
   backdrop-filter: blur(10px) saturate(140%) !important;
   -webkit-backdrop-filter: blur(10px) saturate(140%) !important;
   border-bottom: 1px solid var(--nav-border-scrolled) !important;
 }
+
 #__docusaurus:not(:has(.ord-home-flag)) .navbar::before {
   opacity: 0 !important;
 }

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

@@ -116,6 +116,11 @@
               "const": "open",
               "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)."
             },
+            {
+              "const": "basic-auth",
+              "description": "The resource definitions are protected via generic basic auth.\nPlease find a more detailed documentation [here](../../spec-extensions/access-strategies/basic-auth).",
+              "x-introduced-in-version": "1.12.1"
+            },
             {
               "const": "sap:oauth-client-credentials:v1",
               "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 @@
             },
             {
               "const": "sap.businesshub:basic-auth:v1",
-              "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)."
+              "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).",
+              "x-deprecated-in-version": "1.12.1",
+              "x-deprecated": "This access strategy is deprecated and will be removed in a future version of the specification.\nPlease use `basic-auth` instead."
             },
             {
               "const": "custom",