Skip to content

Latest commit

 

History

History
169 lines (115 loc) · 8.26 KB

CHANGELOG.md

File metadata and controls

169 lines (115 loc) · 8.26 KB
Raw

CHANGELOG

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog. This project adheres to Semantic Versioning rules, but omits the patch level in the spec version number.

For a roadmap including expected timeline, please refer to ROADMAP.md

[unreleased]

[1.9.2]

Added

Changed

  • Data Product shortDescription and description are now mandatory
    • This is a breaking change, but as the Data Product concept as a whole is beta, we'll introduce it as a patch change.

[1.9.1]

Added

  • Added back FAQ page (can be found under "Details" navbar item)
  • Added autogenerated class diagrams for ORD Documents and Configuration Interface.
  • Added optional systemTypeRestriction to EventResourceIntegrationAspect
    • This can be used to limit the event publisher system type, which can be used to setup the subscription accordingly.
  • Added explicit statement that the same resource definition type MUST NOT be provided more than once.
    • This was already implied, but not stated explicitly.
  • Added two new (optional) SHOULD statements regarding deprecation and sunset lifecycle.
    • They represent common sense / practice and help with validating a good usage of the related attributes.
    • If successors is given, the described resource SHOULD set its releaseStatus to deprecated.
    • If a resource is deprecated without defining its successors, a sunsetDate SHOULD be provided.
  • Clarification on consumer expectations toward lastUpdate property.

Changed

  • Renamed the term application namespace to system namespace
    • This is more consistent with the existing ORD terminology around system type
    • As it's only used as a term and not in the interface, this is not a breaking change

[1.9.0]

Added

  • Added new (lightweight) Group and Group Type concept
    • Adds a new partOfGroups attribute on ORD resources
    • Adds two new top level concepts to the ORD document: Group and Group Type
    • This can be used to define custom group types and assign ORD resources to them
    • With this, custom taxonomies can be built that are either centrally or decentrally defined.
  • Added relatedEntityTypes to Entity Types
    • This allows to define that Entity Types are related to other Entity Types (e.g. from a different namespace)
  • Added clarification that an ORD Aggregator MUST bump lastUpdated if the provider didn't do it, but it detected a change.
  • Added explicit Access Strategy description for open, defining how local and global tenant headers can be optionally passed on.
  • Added new Detail Articles:

Changed

  • Providing the sunsetDate for a deprecated resource is now only recommended instead of mandatory (compatible change)
    • "If the releaseStatus is set to deprecated, the sunsetDate SHOULD be provided (if already known)."
    • "Once the sunset date is known and ready to be communicated externally, it MUST be provided here."

[1.8.5]

Fixed

  • Accidentally exported an x- attribute in the ORD JSON Schema interface in Document.schema.json
    • This export is meant to be clean of such extension attributes, as validators as AJV will complain on it by default
    • The Document.annotated.schema.json export keeps the extension attributes intact.

[1.8.4]

Fixed

  • Breaking: The relation of a data product input port to the integration dependency was accidentally modeled as composition, not association,
    • Since the Data Product concept is still in beta, we'll ship this change as a fix and notify current adopters

Added

  • Added statement that there's a reserved customer vendor namespace
  • The .well-known/open-resource-discovery URI is now officially registered.

[1.8.3]

Added

  • Added Excel and CSV files export that gives a high-level overview of ORD entities and their attributes

Removed

  • Removed sap-delta-sharing-combined API resource definition format, as it has not be specified yet.
    • It may be reintroduced in the future, if a specification exists and a producer for it exists.

Fixed

  • Fixed some ORD ID regexp, where it was still allowed to have alpha or beta instead of a major version
    • This affected Capability and Integration Dependency.
    • Instead, the releaseStatus property should be used to set beta.

[1.8.2]

Changed

  • Made accessStrategies optional within the ORD document.
    • If this property is not provided, the definition URL will be available through the same access strategy as this ORD document.
    • It is RECOMMENDED anyway that the attached metadata definitions are available with the same access strategies, to simplify the aggregator crawling process.
  • Minor clarification on visibility of Packages (since they don't have an explicit property for it)

Fixed

  • Product title property did not properly inherit constraints like the other title attributes (min- and max-length)

[1.8.1]

Changed

  • Fix: Data Products need to have at least one output port
    • This is implied through the definition of a Data Product
    • Breaking change that we'll push as a bugfix, as so far it was clear to have at least one output port

[1.8.0]

Added

  • Added Data Product concept.
    • for the time being in beta status
  • Added runtimeRestriction to packages
  • Added responsible to APIs, events and data products
  • Added usage to APIs
  • Added new apiProtocols: delta-sharing and sap-ina-api-v1
  • Added new API Resource Definition type: sap-delta-sharing-combined

Changed

  • Changed values of supportedUseCases on APIs
    • Technically a breaking change, but no consumer used it, therefore it is introduced as minor change
  • Introduced a clear distinction between application namespace and authority namespace instead of "unit namespace"
    • At SAP we already made that distinction.
    • Having a unit-namespace as a simplification didn't work out in all cases and introduced an unnecessary new term
    • This change only affects how we name things and allows us to be more precise
    • For Entity Type its now clearly stated that they can also have an authority namespace

[1.7.2]

Fixed

  • Fixed type of minVersion property. It was accidentally set to boolean, but is obviously meant as a (semver) version string

[1.7.1]

Added