Skip to content

ADR-49 ensure support future multi version API#135

Open
schuur wants to merge 6 commits intomainfrom
pact/adr49-hotfix-for-multiple-versions
Open

ADR-49 ensure support future multi version API#135
schuur wants to merge 6 commits intomainfrom
pact/adr49-hotfix-for-multiple-versions

Conversation

@schuur
Copy link
Contributor

@schuur schuur commented May 7, 2025

ADR 0048 proposes a way of supporting multiple versions of the product carbon footprint (PCF) data model over 3.0 API. In effect this would mean splitting the version of the API and the version of the data model.

Because of tight timelines we cannot include this in version 3.0 of the standard yet. We as PACT feel that, because of the added complexity it brings, it needs more reasoning, more reference cases to other architecture and more feedback from software solution providers implementing real-world data exchange.

In order to make future realization of ADR 0048 possible without requring us to wait for a new backwards incompatible version 4.0, we can include ADR 0049: adding a mandatory specVersion parameter, which is fixed to specVersion=3. This will enable us to introduce a multi-version API as a minor release (3.x) because it will not break backwards compatibility with existing 3.0 APIs.

Alternatives are:

  • Introduce this in 4.0
  • Rely on current (most common) versioning approach: support multiple versions by implementing multiple versions of the API:
    • pcf.exchange.com/pact/2/...
    • pcf.exchange.com/pact/3/...

@schuur schuur changed the title ADR-49 adding mandatory version=3 parameter to support future multi version API ADR-49 ensure support future multi version API May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments