@open-resource-discovery/specification 1.15.0 → 1.16.0

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.
@@ -425,7 +425,7 @@
425
425
  "root": {
426
426
  "type": "boolean",
427
427
  "const": true,
428
- "description": "Concept-level selector targeting the root of the document being patched.\nMUST be `true`.\n\nUse this selector to patch top-level properties of any JSON/YAML-based metadata format\nwithout coupling to specific structural paths. This is especially useful for:\n\n- Patching document-level metadata (title, description, version, contact info)\n- Adding or merging top-level sections (e.g. `components`, `tags`, `servers` in OpenAPI)\n- Extending the root object with new properties across format versions\n\nSupported metadata formats and typical use cases:\n\n**OpenAPI** (`openapi-v2`, `openapi-v3`, `openapi-v3.1+`):\n- Patch `info.description`, `info.title`, `info.contact`\n- Add `components.securitySchemes` or `components.schemas`\n- Add `tags`, `servers`, or `externalDocs`\n\n**AsyncAPI** (`asyncapi-v2`):\n- Patch `info` block, `servers`, `channels` at the root\n\n**OData CSDL JSON** (`csdl-json`):\n- Patch root-level `$Version`, `$EntityContainer`, or add namespace objects\n\n**ORD Document** (no specific `definitionType`):\n- Patch root-level ORD document properties\n\n**MCP / A2A** (any Specification ID):\n- Patch top-level metadata or add root-level tool/skill definitions\n\nThe `root` selector is equivalent to `jsonPath: \"$\"` but is preferred because it\nexplicitly communicates intent and is resilient to format differences where `$`\nmight have ambiguous semantics."
428
+ "description": "Concept-level selector targeting the root of the document being patched.\nMUST be `true`.\n\nUse this selector to patch top-level properties of any JSON/YAML-based metadata format\nwithout coupling to specific structural paths. This is especially useful for:\n\n- Patching document-level metadata (title, description, version, contact info)\n- Adding or merging top-level sections (e.g. `components`, `tags`, `servers` in OpenAPI)\n- Extending the root object with new properties across format versions\n\nSupported metadata formats and typical use cases:\n\n**OpenAPI** (`openapi-v2`, `openapi-v3`, `openapi-v3.1+`):\n- Patch `info.description`, `info.title`, `info.contact`\n- Add `components.securitySchemes` or `components.schemas`\n- Add `tags`, `servers`, or `externalDocs`\n\n**AsyncAPI** (`asyncapi-v2`):\n- Patch `info` block, `servers`, `channels` at the root\n\n**OData CSDL JSON** (`csdl-json`):\n- Patch root-level `$Version`, `$EntityContainer`, or add namespace objects\n\n**MCP / A2A** (any Specification ID):\n- Patch top-level metadata or add root-level tool/skill definitions\n\nThe `root` selector is equivalent to `jsonPath: \"$\"` but is preferred because it\nexplicitly communicates intent and is resilient to format differences where `$`\nmight have ambiguous semantics."
429
429
  }
430
430
  },
431
431
  "examples": [
@@ -762,7 +762,7 @@
762
762
  "baseUrl": {
763
763
  "type": "string",
764
764
  "format": "uri-reference",
765
- "description": "Optional [base URL](../../spec-v1/index.md#base-url) of the system instance.\nBy providing the base URL, relative URLs in the overlay are resolved relative to it.",
765
+ "description": "Optional [base URL](../../spec-v1/index.md#base-url) of the system instance.\nBy providing the base URL, relative URLs in the overlay are resolved relative to it.\n\nThe `baseUrl` MUST NOT contain a trailing slash.",
766
766
  "pattern": "^http[s]?:\\/\\/[^:\\/\\s]+\\.[^:\\/\\s\\.]+(:\\d+)?(\\/[a-zA-Z0-9-\\._~]+)*$",
767
767
  "examples": [
768
768
  "https://example-sap-system.com",
@@ -16,7 +16,7 @@ export interface OrdConfiguration {
16
16
  /**
17
17
  * Optional [base URL](../index.md#base-url) that can be used to resolve the relative URLs to the ORD Documents.
18
18
  *
19
- * The `baseUrl` MUST NOT contain a leading slash.
19
+ * The `baseUrl` MUST NOT contain a trailing slash.
20
20
  *
21
21
  * 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.
22
22
  * This implies that either a `baseUrl` or only absolute URLs MUST be provided when no standardized well-known URI is used.