Skip to content

v1.17.0

Latest

Choose a tag to compare

@Fannon Fannon released this 12 Oct 10:46
· 2 commits to main since this release
6bf430b

Added

  • Added relatedDataProducts to Data Products for expressing typed relationships to other Data Products through extensible reference objects.
  • Added Arazzo Specification support for describing multi-step API workflows.
    • Added standardized Capability type workflow with definition type arazzo-v1.
    • Added arazzo-v1 to ORD Overlay target definition types.
    • Added ord:orchestrates as a relatedApiResources.relationType value for declaring that the source resource orchestrates the target API Resource.
  • Added optional describedSystemInstance.globalId property for a globally unique and stable tenant identifier assigned by the responsible tenant authority.
    It records the same identity that can be passed as the Global-Tenant-Id header in the open and basic-auth access strategies.
    ORD Overlays support the same identifier in describedSystemInstance and target.systemInstance, with matching identity semantics and validation constraints.
    Cross-linked localId/Local-Tenant-Id and globalId/Global-Tenant-Id between the ORD Document interface and the access-strategy documentation.
  • Added systemTypes to IntegrationAspect for dependencies on system types that do not require a specific resource contract, including an optional minimum system version.
  • Added standardized Capability types agent-skill and agent-plugin, with agent-skill-zip and agent-plugin-zip definitions for distributing skills and plugin bundles as ZIP archives.
  • Added integrationDependencies to Capabilities, allowing them to declare required API Resources, Event Resources, or other Capabilities. Dependencies on bundling capabilities such as agent plugins can use subset.skillName to identify only the required skills. See AI Agents and Protocols: Skill Dependencies.
  • Added partOfProducts, responsible, lifecycle metadata, taxonomy, policyLevels, and extensible to Capabilities for consistency with other ORD resources and support for custom fields.
  • Added support for OpenAPI Initiative Overlay v1.0.0: API Resources can publish oas-overlay-v1 definitions, and ORD Overlays can target them. The ORD Overlay documentation now explains how the two overlay specifications interoperate.
  • Added the sap:documentation:v1 policy level for human-readable metadata requirements. sap:core:v1 now inherits this policy level.

Changed

  • Made IntegrationAspect.title optional. Existing documents remain valid, but consumers MUST handle aspects without a title, for example by deriving a display label from the referenced resources or system types.
    The exported TypeScript Aspect.title property is now optional; consumers that assumed a title was always present may require source changes when upgrading. Documents with title-less aspects do not validate against earlier schemas.
  • Allowed customer-namespaced ORD IDs to be published globally when the allocating platform guarantees global uniqueness across customer scopes; otherwise partner content still requires ORD IDs under the partner's registered vendor namespace.
  • Clarified native resource-definition version alignment: versions SHOULD match ORD versions where possible; non-SemVer versions must be converted while preserving ordering and compatibility semantics as closely as possible. Aligned the schema description with the existing overview and concept guidance.
  • Clarified identifier and lifecycle guidance: Specification IDs do not allow / in the specification identifier, runtime extensions MAY use SemVer build metadata but MUST update lastUpdate, and decommissioned resources or unused taxonomy require tombstones; resources may be removed or retained with releaseStatus: sunset and a sunsetDate.
  • sap:core:v1 now requires all ORD Overlays to have effective internal or private visibility and requires SAP publishers to use ord:overlay:v1 rather than oas-overlay-v1 for published overlays.

Merged PRs

  • Update GitHub release action by @nirooxx in #195
  • Improve mobile navbar responsiveness by @Fannon in #196
  • Add SAP Documentation v1 policy level by @pavelkornev in #199
  • Restore ORD Concepts link in specification menu by @Fannon in #200
  • Align ORD introduction, landing page, and presentation diagrams by @Fannon in #203
  • Improve ORD ecosystem and onboarding links by @Fannon in #197
  • Improve the ORD landing and Help pages by @Fannon in #204
  • docs: synchronize specification diagrams with presentation by @Fannon in #205
  • Clarify native version alignment and SemVer conversion by @Fannon in #211
  • Link concept guides directly to matching presentation topics by @Fannon in #210
  • Align diagram captions and Agent explanations with the ORD model by @Fannon in #209
  • Keep replacement diagrams readable and preserve perspective rules by @Fannon in #208
  • docs: require non-public visibility for ORD overlays in sap:core:v1 by @nirooxx in #207
  • docs: restructure specification documentation by @Fannon in #212
  • docs: reconcile identifier, versioning, and publication guidance by @Fannon in #213
  • docs: allow globally unique customer namespace IDs by @Fannon in #214
  • Clarify customer and partner ownership semantics by @Fannon in #216
  • Support Agent Skills and Agent Plugins as ORD capability types by @Fannon in #102
  • Align Capability metadata with other ORD resources by @Fannon in #202
  • Add extensibility to Capabilities by @Fannon in #183
  • Allow Integration Dependencies on system types by @Fannon in #181
  • Make IntegrationAspect.title optional by @Fannon in #215
  • Add describedSystemInstance.globalId for global tenant correlation by @Fannon in #174
  • Add Arazzo workflow support by @Fannon in #158
  • Add OpenAPI Overlay v1 resource definition support by @Fannon in #157
  • Add related Data Product relationships by @Fannon in #188
  • Release v1.17.0 by @Fannon in #217
  • chore: update changelog for version 1.17.0 by @github-actions[bot] in #220

New Contributors

  • @github-actions[bot] made their first contribution in #220

Full Changelog: v1.16.4...v1.17.0